EasyDoc

Документация

• 中文文档
• English Document

Что такое EasyDoc?

EasyDoc — это инструмент, который позволяет легко создавать документы.

Произношение EasyDoc: [ˈiziˈdɑk] sound file.

Коммуникация

• Gitter: https://gitter.im/wuyumin/easydoc
• GitHub: https://github.com/wuyumin/easydoc. Добро пожаловать и ставьте звёзды!

Обновления программного обеспечения и загрузка

Ссылка для загрузки программного обеспечения (сжатый пакет необходимо распаковать, чтобы получить файл программного обеспечения).

Существует только один файл программного обеспечения, его не нужно устанавливать, он не зависит от других программ, поддерживает компьютеры с операционной системой Microsoft, Apple и Linux.

Как обновить программное обеспечение: загрузите новый файл программного обеспечения и замените им старый.

EasyDoc разработан на языке Go, это программное обеспечение с открытым исходным кодом, вы можете использовать исходный код для компиляции. На самом деле вам не нужно этого делать, мы уже скомпилировали и оптимизировали программное обеспечение для скачивания.

Использование командной строки

Убедитесь, что файл программного обеспечения EasyDoc можно выполнить!

Файл программного обеспечения в текущем каталоге:

• Windows: $ easydoc -version
• Unix-подобные системы (например, Mac, Linux. Обратите внимание, что перед ./): $ ./easydoc -version. Вы можете поместить файл программного обеспечения EasyDoc в каталог глобальной среды (рекомендуется использовать этот способ), тогда вы сможете использовать его где угодно: $ easydoc -version.

В настоящее время поддерживаемые команды EasyDoc:

Не забудьте поставить маленькую горизонтальную черту перед каждой командой!

-init Инициализация структуры документа
-build Сборка документа
-server Запуск веб-сервера (используется [или нет] с портом -port и путём -path, порт по умолчанию — 80 -port 80, путь по умолчанию — каталог dist -path ./dist)
-emptydist Очистка каталога dist
-help Справка по EasyDoc
-version Печать номера версии EasyDoc

Статические документы, созданные с помощью EasyDoc, помещаются в каталог dist, используйте или скопируйте этот каталог непосредственно как каталог сайта.

Базовая структура каталогов

Используйте команду -init, чтобы автоматически создать:

├── dist //release directory
├── config
│   └── config.toml //Configuration file, using toml syntax
├── src //Writing directory: store .md source files(required, support to store in this directory and its subdirectories)
│   ├── index.md //Home(not required, but recommended)
│   ├── NO-asset-folder.txt //To avoid conflicts, prompt src directory with caution asset and static subdirectory
│   └── NO-static-folder.txt
├── static //Static file directory, this directory will be completely copied to the release directory(Flexibility to use it for file layout)
└── theme //Template directory (support multiple sets of templates)
    └── default //This default template
        ├── css
        │   └── style.css //Css file in template(No,use the software's default)
        ├── js
        │   └── app.js //Js file in the template(No,use the software's default)
        ├── doc.tpl //Document template(No,use the software's default)
        └── menu.tpl //Menu template(The menu is generated in order, Explanations below.)
├── easydoc.exe //software file(Recommended put it on the global environment directory

• Файлы исходного кода написаны с использованием синтаксиса Markdown. Они хранятся в каталоге src, поддерживается многоуровневая вложенность подкаталогов (подсказка: будьте осторожны с активами и статическими подкаталогами в каталоге src).
• При генерации веб-ссылок на неправильный путь вы можете исправить это с помощью файла config.toml (абсолютный путь лучше).
• Меню генерируется в порядке: содержимое шаблона menu.tpl не пусто > массив scanFile в config.toml не пуст (заголовок настройки используется в качестве заголовка меню). Автоматическое сканирование файлов .md в директории src для генерации

Название файла без суффикса как название ссылки.

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

Массив scanFile для config.toml не пуст.

Название настройки как заголовок документа.

Автоматическое сканирование файлов .md в директории src для генерации.

Название файла без суффикса как заголовок документа.

Формат заполнения массива scanFile в config.toml:

scanFile = [
    ["Link title", "базируется на директории src, путь к файлу .md, который начинается с символа src (поддерживает внешнюю ссылку)"],
    ["Home", "src/index.md"],
    ["XXX page", "src/sub/XXX.md"]
]

Вклад

GitHub: https://github.com/wuyumin/easydoc. Добро пожаловать и ставьте звёзды!

Помогите нам улучшить проект: отправьте вопрос через submit an issue to us или запрос на вытягивание через pull request to us.

Кто использует EasyDoc

Добро пожаловать в раздел «Кто использует EasyDoc».

• Сайт документов EasyDoc