Слияние кода завершено, страница обновится автоматически
rdoc
rdoc — это основанный на React быстрый генератор статических веб-сайтов, для которого требуется только Markdown-документ. Посетите react-doc.github.io, чтобы получить дополнительную информацию.
Этот документ представляет собой демонстрационный пример.
Использовать 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, чтобы решить проблему конфликта команд Mac при использовании rdoc.
rdoc init my-project # Init project
# или
rdoc-cli init my-project
cd my-project && npm install # Перейти в каталог и установить зависимости
npm start # Запустить сервер.
npm run build
{
"scripts": {
"deploy": "rdoc --publish <your repo url>"
...
},
...
}
npm run deploy
Использование: rdoc [параметры]
Быстрый генератор статических сайтов на основе React.
Параметры:
-i, init [путь] создать пустой сайт или повторно инициализировать существующий сайт.
-d, --doc <путь> сгенерировать указанный другой документ.
-o, --output <путь> записать скомпилированные файлы в папку на диске. (по умолчанию: .rdoc-dist)
-p, --port [число] порт. (по умолчанию: 5858)
--host [хост] хост. (по умолчанию: 0.0.0.0)
-b, --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)
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )