md.proj.pw

Documentação do site md.proj.pw.

View on GitHub
readme.md
Edit this doc

Olá, mundo!

Bem-vindo ao md.proj.pw! Um experimento de documentações hospedadas em seu repositório do Github. Esse aplicativo oferece um leitor de documentações e arquivos em Markdown diretamente do seu repositório do Github. Principais vantagens:

  • Suporte à versionamento: cada branch é uma documentação separada. Você pode criar quantas documentações quiser para cada branch que for precisar. Use branches para separar versões, linguas ou outros artefatos interessantes da documentação. Toda alteração no Github reflete aqui, sem precisar editar sua documentação em dois lugares diferentes.
  • Customização: você pode customizar cada parte da sua documentação diretamente do seu repositório do Github. A partir do arquivo schema.json você define:
    • Links: edite os links que aparece no menu de navegação ao lado, editando sua ordem, categoria e apontamentos.
    • Cores: edite as cores primárias do seu projeto, tema e aplique um CSS adicional caso queira.
    • Botões: mostre ou oculte certos botões, como botão de editar acima dessa página, botões de navegação no rodapé e botão de versionamento.
    • Links automáticos: essa documentação interpreta links e associa eles à seu repositório conforme necessitar. Links relativos são suportados e não tiram você dessa documentação. Links externos abrem em outras guias e imagens obtém o conteúdo diretamente do repositório.
    • Título, descrição e ícone: edite o título, descrição e ícone da sua documentação por lá também.
  • Sincronia: tudo o que é exibido aqui é obtido diretamente do seu repositório. Somente repositórios públicos são suportados, pois são acessados pela API do Github. Além disso, pode ser que algumas informações levem até 10 minutos para atualizar, pois usamos cache para evitar flood na API do Github.
  • Para todas as telas: abra sua documentação no celular, tablet, computador ou TV. (quase) todas as telas são suportadas.

Começar

Comece agora criar sua documentação! Clone esse repositório como um quickstarter e comece a escrever sua documentação.

Quando estiver pronto, acesse md.proj.pw, informe o link para seu repositório e o branch inicial de onde irá obter a documentação. Após isso, clique no botão e sua documentação estará pronta.