OSCHINA-MIRROR/jaywcjlove-rdoc

rdoc

Blazing-fast статический генератор сайтов для React, просто напишите файл Markdown. Посетите веб-сайт react-doc.github.io для получения дополнительной информации.

Сайт документации также является демонстрационным примером example.

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

Начать работу с rdoc очень просто. Просто установите его как модуль и запустите, чтобы создать свой веб-сайт.

Давайте начнём!

Установка

Установите rdoc глобально в вашей системе. Вам потребуется иметь Node >= 8 на вашем локальном компьютере разработки. Вы можете использовать n, чтобы легко переключать версии Node между различными проектами.

npm install rdoc -g

# /usr/local/bin/rdoc -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js
# /usr/local/bin/rdoc-cli -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js

Добавлена команда rdoc-cli для разрешения конфликтов команд rdoc на Mac.

Инициализация проекта

rdoc init my-project  # Инициализировать проект
# или
rdoc-cli init my-project

Запустите веб-сайт

cd my-project && npm install # Установить зависимости.
npm start # В каталоге запустите службу.

Скомпилируйте выходные статические HTML-ресурсы

npm run build

Настройте URL-адрес развёртывания в package.json

{
  "scripts": {
    "deploy": "rdoc --publish <your repo url>"
    ...
  },
  ...
}

Разверните на ветке Github gh-pages

npm run deploy

Команда

Использование: rdoc [options]

Быстрый статический сайт-генератор для React.

Опции:

  -i, init [path]        Создать пустой веб-сайт или повторно инициализировать существующий.
  -d, --doc <path>       Другие сгенерированные документы.
  -o, --output <path>    Записывает скомпилированный файл в каталог диска. (по умолчанию: .rdoc-dist)
  -p, --port [number]    Порт. (по умолчанию: 5858)
  --host [host]      Хост. (по умолчанию: 0.0.0.0)
  -b, --branch <branch>  Имя ветки, в которую вы нажимаете. (по умолчанию: gh-pages)
  --publish [url]        Другие сгенерированные документы.
  --build                Создание оптимизированной производственной сборки.
  --clean                Удалить папку .cache.
  -h, --help             вывести информацию об использовании

Примеры:

  $ rdoc init
  $ rdoc init doc-example
  $ rdoc -d doc/mm
  $ rdoc -d tutorial,doc
  $ rdoc -d tutorial,doc --clean --build
  $ rdoc -p 2323  -d doc --clean
  $ rdoc --host 0.0.0.0 -d doc --clean
  $ rdoc --publish https://<your-git-repo>.git --branch master

Разработка

Для разработки запустите самоперезагружающуюся сборку, получите код:

$ git clone https://github.com/jaywcjlove/rdoc.git
$ cd rdoc     # В каталог
$ npm install # или yarn install

Чтобы разработать, запустите самоперезапускающуюся сборку:

# Запустить приложение
# Автоматически перезапускать приложение каждый раз при изменении кода. 
# Полезно во время разработки.
$ npm run start

Откройте браузер и посетите http://localhost:5858

Папки

.
├── README.md
├── .rdoc-dist
├── package.json
├── src
│   ├── build.js
│   ├── commands
│   ├── conf
│   ├── publish.js
│   ├── server.js
│   ├── utils
│   └── web
├── templates
│   └── default # документ статического файла.
└── theme
    └── default

Лицензия

Лицензия MIT (MIT)