magi deprecated

волхвы

Самый простой способ создать веб-сайт для вашего проекта OSS.

Установить

 Yarn global добавить magi# или npm npm i -g magi

Использование

Учитывая README.md :

 # имя сайта> описание сайта## название раздела> описание раздела содержимое раздела, **выглядит неплохо, да**.

Запустите magi в своем терминале, откройте браузер и вы увидите:

Как это работает?

# h1 используется в качестве имени сайта, blockquote после него будет использоваться в качестве описания сайта, а все остальное между h1 и h2 будет помещено в баннер.

Вот еще один пример использования developmentit/unfetch:

Рецепты

Добавьте угловую ленту GitHub

Вы можете использовать html-matter, чтобы установить его в любом месте вашего файла уценки, например, вверху:

 <!-- @magigithub: владелец/репо-->

Обратите внимание, что он должен начинаться с @magi , чтобы мы знали, что нам нужно его проанализировать, остальная часть — это простой синтаксис, используемый в Jekyll.

Внешние стили и скрипты

Чтобы вставить тег style и script с внешним ресурсом:

 <!-- @magistyles: - ./css/custom.cssscripts: - ./js/app.js - ./js/post.js-->

интерфейс командной строки

 # по умолчанию README.md# запуск сервера для предварительного просмотраmagi [файл]# сборка html filemagi build [файл]# по умолчанию вывод в index.html# но вы можете изменить егоmagi build [файл] --out docs/index.html

Содействие

1. Развилка!

2. Создайте свою ветку функций: git checkout -b my-new-feature

3. Зафиксируйте изменения: git commit -am 'Add some feature'

4. Нажмите на ветку: git push origin my-new-feature

5. Отправьте запрос на вытягивание :D

Автор

magi © эгоист, выпущено по лицензии MIT.
Автор и поддерживается эгоистом при помощи участников (список).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin