Система online документации для JavaScript — ADWiki



    Ссылочки


    Что ADWiki умеет:
    • Парсить файлы Вашего проекта описанные на jsdoc
    • Поднимать сайт с чистеньким дизайном на bootstrap
    • Организовывать на сайте небольшой блог, где Вы сможете дополнять документацию статьями о проекте




    Что у ADWiki на уме
    • Улучшать отображение документации
    • Оправдать последние 4 буквы своего названия и дать возможность пользователям редактировать документацию прямо на сайте, а после сохранять в код
    • Мультиязычность
    • Хорошенький поиск по документации
    • Всякая социальщина типа коментов, плюсов, контактов..


    Что ADWiki хочет
    • Вашей помощи в развитии
    • Ваших форков и пул реквестов
    • Уметь разбираться в других языках


    Новости об изменениях можно будет читать в твиттере @node_autodafe
    Предложения, пожелания, вопросы можете писать на почту balakirev.andrey@gmail.com с темой adwiki
    AdBlock похитил этот баннер, но баннеры не зубы — отрастут

    Подробнее
    Реклама

    Комментарии 8

      0
      Неплохо.
      Посмотрите ещё, как сделана документация у Sencha: docs.sencha.com/ext-js/4-0/#!/api/Ext.grid.plugin.CellEditing
      Ко всем компонентам есть примеры (они тоже берутся из jsdoc), так вот эти примеры можно редактировать (но не сохранять) и запускать прямо на странице документации — кнопки [Code Editor] и [Live Priview].
        0
        Парсер прямую ссылку поломал: http://docs.sencha.com/ext-js/4-0/#!/api/Ext.grid.plugin.CellEditing.
          0
          Продолжая ветку комментариев — что в вашем решении лучше jsduck?
            0
            ADWiki задумана как нечто более легкое, без такого нагромаждения скриптов. Документация extjs на некоторых страницах подвешивает у меня браузер на пару секунд. Хотя безусловно по функционалу jsduck сейчас куда круче.
          +1
          А никто не подскажет генератор документации не обязательно по коду, но типа как у backbone.js на сайте?
          backbonejs.ru/
          underscorejs.ru/
          Или для пользующихся оригиналами: underscorejs.org/
          Или как делается у Highcharts
          api.highcharts.com/highcharts#chart.object
          Или jqApi.com
          jqapi.com/
          В общем, интересно любое решение, но удобное в чтении и с возможностью генерации по своим описаниям в JSON/XML или хотя бы в своём метаязыке или каком-нибудь Yaml.
          +1
          Было бы неплохо сделать из этого какой-нибудь сервис подобный documentup.com без регистрации и смс. Для проектов на GH — открываешь http://ADWiki.com/%gh-user%/%gh-project%/ и проект сам все вытаскивает парсит и рендерит.
            0
            Слушайте… отличная идея! Отмечу себе, как один из возможных вариантов развития.

          Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

          Самое читаемое