Markdoc é voltada para o gerenciamento de documentação técnica, mas pode ser usado para uma variedade de propósitos. Markdoc tem alguns pontos de venda notáveis:
* Wikis são compostos completamente de arquivos de texto simples, assim você pode facilmente colocá-los sob controle de versão.
* Wikis compilar em diretórios HTML autônomos, que podem ser distribuídos como tarballs ou servidos por um servidor HTTP.
* Você pode opcionalmente incluir mídia estática que serão compilados para o diretório HTML juntamente com todas as suas páginas prestados.
* Markdoc vem com um aplicativo de servidor HTTP e totalmente funcional puro-Python WSGI para servir-se wikis compilados.
* Você pode tornar o seu wiki com uma variedade de extensões de remarcação para baixo, como destacar baseada em pygments código, sintaxe estendida para listas de definição, geração de TOC, et cetera.
* Você pode customizar completamente como seu wiki é processado editando os modelos Jinja2 utilizados para converter Markdown prestados em documentos HTML completos.
Início rápido
Instalação:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip instalar REQUISITOS -r
python setup.py install
Fazendo um Wiki
#! / Bin / bash
markdoc o init meu-wiki
cd meu-wiki /
vim wiki / somefile.md
# ... Escrever alguma documentação ...
construção markdoc
markdoc servir
# .. Http aberto: // localhost: 8008 / em um navegador ...
Layout
Wikis Markdoc ter a seguinte layout padrão:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Static /
| - Wiki /
`- Markdoc.yaml
O .html / tmp e / diretórios devem ser excluídos de qualquer VCS, uma vez que contêm arquivos temporários.
Consulte a documentação do layout no doc / wiki / layout.md para mais informações sobre os papéis dos vários subdiretórios
Requisitos :.
- Python
- pip
- rsync
Comentários não encontrado