Ich suche nach einem Tool, das statische HTML-Seiten aus Markdown-Dateien generieren kann. So weit so gut, es gibt viele:
Mein Problem ist, dass ich eine Dokumentation für ein eigenständiges Software-Repository schreiben möchte. Es sollte wie folgt funktionieren:
createDocs.bat
Mein Problem ist nun, dass alle oben genannten Tools eine Art Umgebung benötigen, die zuvor eingerichtet wurde: node.js, Python und zusätzliche Module, ... Die Idee hinter der in sich geschlossenen Umgebung ist jedoch
Kennt jemand ein gutes Tool, das so funktioniert? Gibt es Möglichkeiten, die oben genannten Tools zum Laufen zu bringen? Ich habe gerade viele Dinge ausprobiert, wie das Konvertieren von mkdocs mit py2exe, hatte aber keinen Erfolg ...
Doxygen ist ein Allzweck-Code-Dokumentationstool. Es unterstützt Markdown ab Version 1.8.0 und kann statische HTML-Dateien neben vielen anderen Formaten generieren.
Merkmale:
Ihr gewünschter Workflow lässt sich mit doxygen ganz einfach realisieren:
doxygen <path-to-configuration-file>
aus, der einfach in eine Batch-Datei eingefügt werden kannindex.html
erscheint im Arbeitsverzeichnis, das der Benutzer in seinem Browser öffnen kann. Meine persönliche Vorliebe ist es, einen zusätzlichen Kompilierbefehl einzufügen, der eine chm
Datei erzeugt, die mit der Systemhilfe in Windows geöffnet werden kann .Ich kann mir ein paar Möglichkeiten für dich vorstellen:
Beide oben genannten Anforderungen erfüllen:
Aber in jedem der oben genannten Fälle würde ich dringend empfehlen, Ihren gewünschten Workflow zu ändern, um einen Schritt "Entwickler lädt das Tool herunter und entpackt es" hinzuzufügen, da es viele Gründe gibt, Binärdateien nicht in Revisionskontrollsysteme zu stellen, und viele Unternehmens-VCSs haben spezifische Richtlinien um Sie daran zu hindern.
Die andere Option könnte darin bestehen, einen Online-Dokumenterstellungsserver zu erstellen, jedoch hinter der Unternehmens-Firewall. Dies würde nicht offline funktionieren, würde aber viel mehr Kontrolle darüber bieten, welche Software verwendet wird. Dies könnte auch über Hooks in das VCS integriert werden, sodass der Workflow folgendermaßen geändert wird:
Dies erfüllt nicht Ihre erste Anforderung, bietet aber einige Vorteile:
Ira Baxter