Markdoc es excelente para la documentación técnica, manuales, wikis proyecto interno, o generaciones sitio estático.
Para documentación técnica / Manuales, Markdoc se puede utilizar para escribir y dar guías y manuales escritos a mano para el software. Dicha documentación será normalmente separada de documentación de la API genera automáticamente y podría dar una visión de alto nivel de documentación de la API solos. Podría ser utilizado para la documentación del cliente para aplicaciones web / escritorio, o incluso documentación de desarrollo de marcos.
Para Interna del Proyecto Wikis, wikis Markdoc consisten en un único archivo de texto plano por página. Al combinar un wiki con DVCS (como Mercurial o Git), puede colaborar con otras personas. Utilice los DVCS para realizar un seguimiento, compartir y combinar los cambios de unos con otros, y ver el wiki y rsquo; s la historia.
Para estático Generación del sitio, Markdoc convierte wikis en archivos HTML primas y medios de comunicación. Esto le permite administrar un blog, sitio web personal o una colección de páginas de un wiki Markdoc, tal vez con estilos CSS personalizado y publicar el HTML representado a un sitio web. Markdoc no necesita ser instalado en el sitio de alojamiento, ya que el HTML resultante es completamente independiente
Características .
- Configure Google seguimiento de Google Analytics en una línea de configuración.
- wikis barebones que simplemente parecen directorios con archivos de texto con formato Markdown en ellos.
- Un built-in del servidor HTTP y aplicación WSGI para servir un wiki compilado con un solo comando.
- construye continua (mediante rsync) significa que el servidor pueda seguir funcionando mientras Markdoc re-compila el wiki. Sólo actualizar su navegador para ver los cambios.
- Añadir sintaxis Pygments-powered destacando a tu wiki Markdoc con un parámetro de configuración única.
- Markdoc es software de dominio público. Siempre será completamente libre de usar, y usted puede redistribuirlo (en parte o en su totalidad) bajo ninguna circunstancia (de código abierto, de propiedad o de otro tipo) sin atribución o encumberances.
Requisitos
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- WebOb
- Python 2.4 o superior
- rsync
Comentarios que no se encuentran