magi deprecated

mago

A maneira mais simples de construir um site para seu projeto OSS.

Instalar

 yarn global add magi# ou npm npm i -g magi

Uso

Dado README.md :

 # nome do site> descrição do site## título da seção> descrição da seção conteúdo do corpo da seção, **não parece ruim, hein**.

Execute magi em seu terminal, abra o navegador e você verá:

Como funciona?

# h1 é usado como nome do site, blockquote depois disso será usado como descrição do site, e todos os outros itens entre h1 e h2 serão colocados no banner.

Aqui está outro usando development/unfetch como exemplo:

Receitas

Adicione uma faixa de canto do GitHub

Você pode usar html-matter para defini-lo em qualquer lugar do seu arquivo markdown, por exemplo, na parte superior dele:

 <!-- @magigithub: proprietário/repo-->

Observe que ele deve começar com @magi para que saibamos que precisamos analisá-lo, o resto é uma sintaxe simples de front-matter usada no Jekyll.

Estilos e scripts externos

Para inserir style e tag script com recurso externo:

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

CLI

 # o padrão é README.md# execute o servidor para visualizarmagi [arquivo]# build html filemagi build [arquivo]# o padrão é a saída para index.html# mas você pode alterar itmagi build [arquivo] --out docs/index.html

Contribuindo

1. Garfo!

2. Crie seu branch de recursos: git checkout -b my-new-feature

3. Confirme suas alterações: git commit -am 'Add some feature'

4. Empurre para o branch: git push origin my-new-feature

5. Envie uma solicitação pull :D

Autor

magi © egoísta, lançado sob a licença do MIT.
De autoria e mantido por egoísta com ajuda de contribuidores (lista).

egoistian.com · GitHub @egoist · Twitter @rem_rin_rin