Markdoc está orientado a la gestión de la documentación técnica, pero puede ser utilizado para una variedad de propósitos. Markdoc tiene algunos puntos de venta notables:
* Wikis se componen por completo de los archivos de texto plano, por lo que puede poner fácilmente bajo control de versiones.
* Wikis compilar en directorios HTML independientes, que se pueden distribuir como archivos tar o cargo de un servidor HTTP.
* Puede incluir opcionalmente medios estáticos que se compilan en el directorio HTML junto a todas sus páginas prestados.
* Markdoc viene con una aplicación de servidor HTTP y totalmente funcional puro Python WSGI para servir a los wikis compilados.
* Usted puede hacer que su wiki con una variedad de extensiones de rebajas, como resaltado basado en Pygments código, sintaxis extendida de listas de definición, generación de TOC, etcétera.
* Usted puede personalizar completamente cómo su wiki se hace mediante la edición de las plantillas Jinja2 utilizados para convertir Markdown dictada en documentos HTML completos.
Inicio rápido
Instalación:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
PIP instalar REQUISITOS -r
python setup.py install
Hacer un Wiki
#! / Bin / bash
markdoc init mi-wiki
cd mi-wiki /
wiki vim / somefile.md
# ... Escribir algún tipo de documentación ...
acumulación markdoc
markdoc servir
# .. Http abierta: // localhost: 8008 / en un navegador ...
Diseño
Wikis Markdoc tienen la siguiente distribución por defecto:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Estática /
| - Wiki /
`- Markdoc.yaml
El .html / tmp y / directorios debe ser excluido de cualquier VCS, ya que contienen archivos temporales.
Consulte la documentación de diseño en el doc / wiki / layout.md para más información sobre las funciones de los diversos subdirectorios
Requisitos .
- Python
- pip
- rsync
Comentarios que no se encuentran