Начало работы

mdoc является генератором, который по набору файлов в формате markdown генерирует html-документацию.

Исходные тексты документации должны находиться внутри модуля.

Добавляем в project.jc модуля настройки для mdoc (MDocProject):

import jandcode.jc.*
import jandcode.mdoc.jc.*

// (1) import для mdoc

class Project1 extends ProjectScript {

    static beforeLoad = {
        // ...

        // (2) mdoc помещаем в classpath для проекта
        classpath("jandcode-mdoc-jc")
    }

    void onInclude() {
        // ...

        // (3) Настраиваем проект для mdoc
        include(MDocProject).with {
            // runtime-зависимости для запуска mdoc
            depends.prod(
            )
            // каталоги с исходниками документации
            addSrc('doc')

            // свойства документации

            // содержание
            props['toc'] = 'toc.xml'
            // заголовок документации
            props['title'] = project.name
        }
    }

}

Создаем папку doc в модуле.

Создаем файл doc/index.md с главной страницей документации:

Привет
======

Это главная страница документации.

Создаем файл doc/toc.xml с содержанием документации:

<root>
    <toc-root topic="index.md">
        <toc topic="**/*" type="auto"/>
    </toc-root>
</root>

Генерируем документацию:

jc mdoc-build

Сгенерированные файлы в каталоге temp/mdoc-doc.

Запускаем отладочный сервер:

jc mdoc-serve

Открываем ссылку http://localhost:4000/. Видим сгенерированную документацию в debug-режиме с различными инструментами.

Создаем дополнительные страницы с любым содержанием:

doc/page1.md
doc/folder1/index.md
doc/folder1/page1.md

Если поменять исходные файлы, то страница в браузере обновится.

Note

Если страница автоматически не обновляется, что возможно при некоторых ситуациях, просто перезагрузите ее сами (F5). Если и это не помогло, нажмите конпку Rebuild на панели инструментов.

Команды на отладочной панели:

Toc - показать виртуальное содержание в соответствии с расположением файлов в проекте
AllFiles - показать все файлы в проекте
View as prod - показать страницу в режиме production, без отладочных инструментов. Для перехода в отладочный режим уберите ?prod из параметров в url или просто перейдите на любую другую страницу.
Rebuild - пересобрать документ и содержание. Активная страница может стать недоступной, если она удалена или перемещена. В этом случае просто перейдите в корень. Команда так же запускается при нажании клавиши 'r'.
Edit - редактировать страницу в редакторе (например в idea). Кроме того редактирование запускатся по двойному щелчку на любом элементе статьи. Или одинарный щелчек для установки маркера и последующем нажатии клавиши 'e' (см. Редактирование).