Markdoc est excellent pour la documentation technique, manuels, wikis de projet interne, ou générations de sites statiques.
Pour la documentation technique / Manuels, Markdoc peut être utilisé pour écrire et rendre guides et manuels écrits à la main pour les logiciels. Cette documentation sera normalement distinct de documentation de l'API générée automatiquement, et pourrait donner une vue de haut niveau que documentation de l'API seuls. Il pourrait être utilisé pour la documentation client pour les applications Web / de bureau, ou même la documentation développeur pour les cadres.
Pour le projet interne Wikis, wikis Markdoc se composent d'un fichier texte unique par page. En combinant un wiki avec un DVCS (tels que Mercurial ou Git), vous pouvez collaborer avec plusieurs autres personnes. Utilisez les DVCS pour suivre, partager et fusionner les modifications avec l'autre, et consulter le wiki & rsquo; s histoire.
Pour statique Génération du Site, Markdoc convertit en fichiers wikis et les médias HTML premières. Cela vous permet de gérer un blog, site personnel ou une collection de pages d'un wiki Markdoc, peut-être avec des styles CSS personnalisés, et de publier le rendu HTML d'un site Web. Markdoc n'a pas besoin d'être installé sur le site d'hébergement, depuis le HTML résultante est complètement indépendant
Caractéristiques :.
- configurer Google suivi Google Analytics dans une ligne de configuration.
- Barebones wikis qui vient ressemblent à des répertoires avec des fichiers texte au format Markdown en eux.
- A built-in serveur HTTP et l'application WSGI pour servir un wiki compilé avec une seule commande.
- construit continu (via rsync) signifie que le serveur peut continuer à fonctionner tout en Markdoc re-compile le wiki. Juste rafraîchir votre navigateur pour voir les changements.
- Ajouter syntaxe Pygments alimenté soulignant à votre wiki Markdoc avec un seul paramètre de configuration.
- Markdoc est un logiciel du domaine public. Il sera toujours complètement libre d'utilisation, et vous pouvez le redistribuer (en partie ou en totalité) en toutes circonstances (open-source, propriétaire ou autre) sans attribution ou sûretés qui.
Exigences :
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- WebOb
- Python 2.4 ou supérieur
- rsync
Commentaires non trouvées