docpress

Docpress

Publicação Markdown indolor

Gerador de sites de documentação.
Gera ótimos sites a partir de arquivos Markdown.

Índice

• O que é
• Exemplos
• Uso
• Apoiar
• Obrigado

O que é

Docpress gera sites a partir da documentação básica do seu projeto; isto é, no mínimo, um arquivo README.md . Ele também oferece suporte a várias páginas Markdown em docs/ .

Em forte desenvolvimento agora; guias e instruções aparecerão magicamente aqui quando estivermos estáveis.

Exemplos

Confira o Docpress Showcase para ver como o Docpress ajudou os desenvolvedores a criar sites de ótima aparência.

Uso

Ainda em forte desenvolvimento, considere isso uma prévia. Requer Nó v8+. Consulte o guia de primeiros passos para obter mais detalhes.

$ npm install -g docpress
$ echo " # My project " > README.md
$ echo " Documented by Markdown files. " >> README.md
$ docpress serve

  Docpress
  starting development - ^C to exit

  350ms ✓   first build                 
      on    watching changes
      on    livereload
      on    http://localhost:3000

  Running

Apoiar

• Documentação
• Bate-papo do Gitter

Vamos construir nosso primeiro site Docpress. Guia de início rápido →

Obrigado

docpress © 2015+, Rico Sta. Cruz. Lançado sob a licença MIT.
De autoria e manutenção de Rico Sta. Cruz com ajuda de colaboradores (lista).

ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz