Слияние кода завершено, страница обновится автоматически
Самый простой способ создать документацию по проекту
Daux.io — это генератор документации, который помогает пользователям быстро создавать красивые документы по проектам. Кроме того, пользователи могут создавать документы с настраиваемым форматом на основе простой файловой структуры и файлов Markdown. Он помогает вам создавать документацию более удобным для разработчиков способом.
Быстрое использование (добавление docx)
Добавьте PHP в системный путь. В командной строке перейдите в каталог docx и запустите команду: php index.php admin deploy your-blog-name.
При использовании nginx rewrite для развёртывания удалите .php$ и замените его на .php или .php(/|$). Также удалите try_files. Убедитесь, что каталоги temp и public доступны для записи. PHP не имеет расширения yaml, поэтому измените cache_ext в конфигурации на .json.
Реорганизуйте код в несколько независимых классов и используйте сжатые библиотечные файлы. Все операции командной строки, кроме git, были перенесены на веб-страницу управления.
Добавлена функция вывода PDF. Необходимо установить WkHtmlToPdf.
Добавлен метатег Metadata в Markdown, поддерживающий настройку заголовка документа, slug и времени. Можно настроить шаблон макета layout, поддерживающий обратный порядок файлов и используемый в качестве статического блога. Пример Metadata:
layout: post
date: 2014-04-08
title: 快速开始
slug: getting-started
tags: 帮助, 快速开始
comments: false
# Настроить git при первом использовании
git config --global user.name "Ryan Liu"
git config --global user.email "azhaixxx@126.com"
# Клонировать исходный код
git clone http://git.oschina.net/azhai/docx.git
# Добавить исходные файлы Markdown в новый репозиторий
cd docx\docs\
git init
cd ..\..
# Следующее относится к управлению статическим блогом, используя gitcafe в качестве примера. Сначала зарегистрируйтесь и создайте проект с тем же именем.
# Обратитесь к их веб-сайту за помощью и получите адрес страниц проекта.
rm -rf static
git submodule add -f https://gitcafe.com/azhai/azhai.git static
cd static
git checkout -b gitcafe-pages
php ..\index.php gen
git add .
git commit -a -m 'Создать статический блог в первый раз'
git push -u origin gitcafe-pages
Вот список сайтов, использующих Daux.io:
Видите ли вы Daux.io? Отправьте pull request или создайте новую проблему, и я добавлю ваш сайт в этот список!
Скачайте zip-версию репозитория и распакуйте её. Скопируйте эти файлы на сервер, на котором работает PHP версии 5.3 или выше. Вы также можете использовать Grunt.js для запуска этих документов локально, метод описан в конце файла readme.
Генератор документов по умолчанию ищет каталог /docs. Добавьте свои каталоги в /docs, чтобы они были включены. Этот проект уже включает несколько примеров папок и файлов, которые помогут вам быстро начать работу.
Вы можете вкладывать папки любого уровня для достижения желаемой структуры. Структура каталогов будет преобразована в вложенное сворачивающееся меню навигации.
Если вы хотите сохранить свои документы в другом месте (например, вне корневого каталога daux.io), вы можете указать путь к документам в конфигурационном файле config.json.
Генератор будет искать файлы Markdown .md в каталоге /docs и его подкаталогах. Переводчик отмечает: Markdown — это облегчённый язык разметки.
Вам необходимо использовать расширение .md для ваших файлов документов. Кроме того, имена файлов должны использовать символы подчёркивания вместо пробелов. Вот несколько примеров имён файлов после преобразования в допустимые форматы:
Рекомендуется:
Не рекомендуется:
Если вам нужно отсортировать файлы и папки, вы можете добавить числа и символы подчёркивания перед именами. Посадка на страницу
Если вы хотите создать красивую посадочную страницу для своего проекта, просто создайте файл index.md в корневом каталоге документов /docs. Этот файл будет использоваться для создания посадочной страницы. Вы также можете добавить логотип бренда и изображение на эту страницу с помощью файла конфигурации:
{
"title": "Daux.io",
"tagline": "Самый простой способ построить документацию вашего проекта",
"image": "img/app.png"
}
Примечание: изображение может быть локальным или удалённым изображением.
Конфигурация
Вы можете создать файл конфигурации config.json в папке /docs, чтобы настроить внешний вид и ощущение документации проекта. Файл конфигурации config.json — это простой объект JSON, который можно изменить, чтобы изменить некоторые базовые настройки документации.
Измените заголовок в этих документах:
{
"title": "Daux.io"
}
Если вы предпочитаете хранить свои документы не в папке Daux.io, вы можете указать путь к файлу в файле конфигурации.
Обратите внимание: ваш файл конфигурации config.json должен оставаться в папке /daux.io/docs.
{
"docs_path": "../../my_docs"
}
Мы предоставляем четыре встроенных темы Bootstrap. Если вы хотите использовать эти темы, просто установите опцию theme в вашем файле конфигурации на одно из следующих значений:
{
"theme": "blue"
}
Пользователи могут настраивать цвета документации, устанавливая свойство theme на custom, а затем определяя цвета для различных элементов. Скопируйте следующий файл конфигурации, чтобы начать настройку цветов документации:
{
"theme": "custom",
"colors": {
"sidebar-background": "#f7f7f7",
"sidebar-hover": "#c5c5cb",
"lines": "#e7e7e9",
"dark": "#3f4657",
"light": "#82becd",
"text": "#2d2d2d",
"syntax-string": "#022e99",
"syntax-comment": "#84989b",
"syntax-number": "#2f9b92",
"syntax-label": "#840d7a"
}
}
По умолчанию код в ваших документах будет плавать справа от содержимого (при ширине экрана более 1150 пикселей). Чтобы отключить эту функцию, установите свойство float на false.
{
"float": false
}
Некоторые пользователи хотят видеть только документацию и скрывать код. Вы можете установить toggle_code на true, чтобы предоставить им эту возможность. В этом случае на странице появится дополнительная кнопка переключения (в навигационной панели внизу).
{
"toggle_code": true
}
Добавьте горизонтальную полосу с надписью «Fork me on GitHub»:
{
"repo": "justinwalsh/daux.io"
}
Включите кнопки Twitter в боковом меню:
{
"twitter": ["justin_walsh", "todaymade"]
}
Включите пользовательские ссылки в боковое меню:
{
"links": {
"GitHub Repo": "https://github.com/justinwalsh/daux.io",
"Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
"Made by Todaymade": "http://todaymade.com"
}
}
Включите редактор Markdown на стороне клиента. По умолчанию отключён.
{
"file_editor": true
}
Здесь будет встроен код отслеживания Google Analytics.
{
"google_analytics": "UA-XXXXXXXXX-XX"
}
Здесь будет встроен код отслеживания Piwik.
{
"piwik_analytics": "my-url-for-piwik.com"
}
Настройте игнорирование определённых файлов и папок в /docs, чтобы они не отображались в документации. Для файлов убедитесь, что расширение файла включено в файл конфигурации. Для папок и файлов имена чувствительны к регистру.
{
"ignore": {
"files": ["Work_In_Progress.md"],
"folders": ["99_Not_Ready"]
}
}
Daux.io по умолчанию создаёт перезапись URL, где URL не содержит index.php. Если сервер работает под управлением Apache, загрузите файл .htaccess, чтобы реализовать перезапись URL. Если сервер не работает под управлением Apache или вы не можете настроить файл .htaccess, вам может потребоваться отключить функцию clean_url, выполнив следующие действия:
{
"clean_urls": false
}
По умолчанию daux.io отображает последнюю обновлённую дату под каждым заголовком документа, полученную от системы. Чтобы отключить эту функцию, измените параметр date_modified в файле конфигурации на false:
{
"date_modified": false
}
Если ваш сервер не имеет установленного часового пояса в php.ini, документация может возвращать ошибку при получении последней даты и времени модификации. Чтобы исправить эту ошибку, укажите часовой пояс в файле конфигурации, используя допустимые параметры, указанные в руководстве PHP PHP Manual.
{
"timezone": "America/Los_Angeles"
}
### Многоязычность
Чтобы включить поддержку нескольких языков, поместите файлы каждого языка в отдельный подкаталог в каталоге `/docs/.
```json
{
"languages": { "en": "English", "de": "German" }
}
Структура каталогов:
├── docs/
│ ├── index.md
│ ├── en
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ └── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md
│ │ │ └── 05_Code_Highlighting.md
│ ├── de
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_GitHub_Flavored_Markdown.md
│ │ │ └── 05_Code_Highlighting.md
│ │ ├── 05_More_Examples
│ │ │ ├── Hello_World.md
│ │ │ └── 05_Code_Highlighting.md
Скопируйте файлы из репозитория в веб-сервер на основе PHP 5.3 или выше.
Вот несколько способов локального запуска генератора документации. Вы можете использовать такие инструменты, как MAMP или XAMPP, для настройки локального сервера.
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Комментарии ( 0 )