Исходные файлы

Содержание

Виртуальный каталог

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

Например, мы имеем такую структуру проекта:

src
- dir1
  - dir2
    - file2.md
  - file1.md
- file3.md(from src)
- file4.md
src2
- dir1
  - dir3
    - file6.md
  - file5.md
- file3.md(from src2)
- file7.md

и настроили проект так:

include(MDocProject).with {
    addSrc('src')
    addSrc('src2')
}

Тогда исходные файлы для mdoc будут выглядеть так:

dir1
- dir2
  - file2.md
- dir3
  - file6.md
- file1.md
- file5.md
file3.md(from src2)
file4.md
file7.md

Обратите внимание, файл file3.md будет использоваться из src2. Т.е. если в исходных каталогах есть одинаковые файлы, то будет использоваться файл из последнего добавленного каталога.

При добавлении папки можно указывать папку, в которую она будет примонтирована:

include(MDocProject).with {
    addSrc('src')
    addSrc('src2', prefix: 'dir1/mount1')
}

Тогда исходные файлы для mdoc будут выглядеть так:

dir1
- dir2
  - file2.md
- mount1
  - dir1
    - dir3
      - file6.md
    - file5.md
  - file3.md(from src2)
  - file7.md
- file1.md
file3.md(from src)
file4.md

_theme

Специальный каталог _theme содержит файлы темы (стили, javascript, картинки) и расширений.

По умолчанию имеется базовая тема, которая автоматически монтируется в каталог _theme. Если есть необходимость изменить файлы темы, то создайте каталог в проекте с именем _theme и пеместите туда нужные файлы. Они перекроют оригинальные файлы темы. Так же можно примонтировать каталог с нужной темой в проект:

include(MDocProject).with {
    addSrc('src')
    addSrc('theme', prefix: '_theme')
}