Wie kann ich den export von Markdown-Dokumentation in verschiedenen Formaten?

Schreiben Der Dokumentation

Als Entwickler, ich habe auf der Suche für die einfachste Art und Weise zu schreiben und update-Dokumentation. Nicht ein langweiliger text, der schreit "don' T read me", aber etwas glücklich (und einfach) formatiert mit extra-leichte Unterstützung für code.

Aus LaTeX, Markdown-wiki, um nur einige zu nennen, ich denke, Markdown ist so nah wie es nur geht. Aber das Dokument selbst ist sehr nerdy und nicht sehr portabel. Das wird werden müssen, um die HTML und PDF.

Markdown-Editor

Also im Grunde, ich bin auf der Suche nach einem editor, Konverter, oder jede cleveren trick, den ich noch nicht gedacht, um diese Dokumentation in HTML und PDF.

Hände nach unten der einfachste editor den ich gefunden habe, ist StackEdit, aber es funktioniert nicht HTML exportieren; es hängt davon ab, online-stylesheets, die nicht richtig verknüpft und die exportierte HTML-ist ziemlich unerträglich, um zu sehen. Es würde nicht funktionieren, offline sowieso.

Exportieren als HTML und PDF

Ich bin auf der Suche nach alle Weg, um dies richtig tun. Ich habe nichts dagegen, wenn es einige stand-alone-Anwendung oder das Skript wandelt die markdown Datei in den richtigen HTML-Code. Ich brauche jemanden, um mir zu zeigen, die tricks in der Dokumentation-Generierung, die ich nicht finden kann.

PDF ist eine andere Geschichte. Ich denke, ich Spam mein computer voll mit HTML-zu-PDF-Konverter, und jeder von Ihnen Hinzugefügt, spam-und Wasserzeichen, um meinen sehr sauberen Dokumentation.

Hi, ich bin der Entwickler von StackEdit. In StackEdit, können Sie ändern Sie die Standard-Vorlage, die verwendet wird zum generieren Ihrer HTML - (Einstellungen->Dienste->Standard-Vorlage). Sie können entfernen Sie die externe stylesheets Abhängigkeiten und sind inline-CSS gibt.
Gut zu wissen, danke. Die Standard-Vorlage sieht gut aus. Gibt es einen Weg, um pandoc (oder doxygen) zu generieren PDF-Dokument mit diesem template/stylesheet?
Ich habe keine Ahnung von pandoc oder doxygen, aber Sie können generieren PDF-Datei direkt aus StackEdit (Menü->Speichern unter...). Die Vorlage für die PDF-Erzeugung kann angepasst werden in den Einstellungen->Dienste->PDF-Vorlage.
Durch die Art und Weise, StackEdit funktioniert auch offline-sobald die Anwendung cache wurde komplett heruntergeladen (dauert etwa 1 minute, während Sie sind auf der Seite)

InformationsquelleAutor Redsandro | 2013-08-29

  1. 6

    Für die Wahl der Ausgabeformate, die Sie wahrscheinlich nicht schlagen können pandoc - es wird konvertieren von Markdown (und viele andere Formate) in HTML, PDF, DocBook, und eine Anzahl mehr. Die Standardwerte sind ziemlich gesund, aber Sie können Ihre eigenen Vorlagen leicht genug, wenn Sie es wünschen. Es hat auch Unterstützung für Sprache spezifischen code-Hervorhebung in Blöcken.

    Dies scheint zu sein, was ich werden könnte suchen. Gib mir etwas Zeit um es heraus zu überprüfen und sehen, ob ich akzeptiere Ihre Antwort. 🙂
    Hinzufügen Sie können ein Beispiel-Befehl für die Konvertierung markdown zu pdf mit pandoc in Ihrer Antwort?
    pandoc -f markdown -o test.pdf test.md. Deine Antwort ist richtig, aber ich finde die Ausgabe Recht einfach/alt/langweilig/hässlich im Verhältnis zu 21st century Implementierungen wie gitHub und Stack Overflow.

    InformationsquelleAutor Oliver Matthews

  2. 3

    Nur zur Ergänzung der vorherigen Antworten:

    Fand ich diese online-Markdown-zu-PDF-Konverter. Aber es gibt einige Nachteile der Verwendung von online-services. Sie können nicht nur verderben das PDF (umsonst?), aber auch Sie nicht übernehmen lokale Bilder in Ihr Dokument ein.

    Hier ist ein offline-Markdown-zu-PDF-Konverter namens Gimli, aber es läuft auf Ruby.

    Gibt es auch andere offline-Konverter MultiMarkdown PDF, aber es nutzt Windows statt.

    InformationsquelleAutor Redsandro

  3. 3

    Den folgenden Buchstaben zu bezeichnen, einige gemeinsame Merkmale:

    • M: Mathematische Formel-syntax unterstützt,

    • G: GitHub Flavoured Markdown

    • L: Live-Vorschau

    • C: Syntax-Hervorhebung für code

    • E: das Exportieren in verschiedene Formate

    • S: Benutzerdefinierte Styling ich.e benutzerdefinierte CSS für HTML, etc.

    • P: Unterstützung für Plug-ins

    • F: Frei

    • D: Aktive Entwicklung

    Hier kommen Sie (in keiner bestimmten Reihenfolge):

    1. Bemerkenswert

    Einfach, elegant, feature-rich
    D F L G S P M C E(pdf, html)

    2. ReText

    Einfach, unterstützt sowohl umstrukturiert text-und markdown
    D F M P E(html, odt, pdf)

    3. UberWriter

    Minimal und leicht
    F C M E(pdf html rtf)

    5. Typora

    Einfache, elegante
    F(while in beta) D G C M L E(html pdf epub docx odt etc.)

    6. Haroopad

    Feature-rich, beta-editor für das Bloggen und mailen, import vieler Formate
    F G L M E(html)

    7. Mark Meine Worte

    Einfach
    F D L E(pdf html)

    8. Gitbook-Editor

    Zur Dokumentation, digital schreiben und publizieren
    D F G L C M E (HTML PDF epub mobi)

    9. Abricotine

    Editor, basierend auf web-Technologie
    L F D G C E(HTML) M S

    10. GhostWriter

    Einfach, Ablenkung-freie, robuste
    F G D E (HTML , other formats by extensions), S

    11. Caret

    Minimal, robust
    D L G C E (PDF) M S

    13. Elegante Markdown-Editor (EME)

    Minimal, einfache
    D L G C E (PDF) M

    14. Plugins

    Sind die folgenden plugins für verschiedene IDEs und Editoren. Einige plugins zum konvertieren zu HTML oder PDF. Überprüfen Sie Sie heraus.
    - Atom

    • Vim: Instant-Markdown-Plugin

    • Halterung: MarkdownPreview Plugin

    • Sublime Text: Markdown-Plugin

    • GNU Emacs

    • Visual Studio-Code -

    • Notepadqq

    • Jetbrains IDEs: Markdown-Navigator

    • Qownnotes

    InformationsquelleAutor Charitoo

  4. 1

    Editor Atom hat ein plugin Vorschau von Markdown-Dateien (.md), die mit einem export als HTML Funktion.

    ...und es hat plugins, die Ihnen ermöglichen, PDF-export. Suchen Sie die Pakete für Markdown in PDF.

    InformationsquelleAutor Aubin

  5. 1

    Haben Sie als Doxygen? Doxygen-Ausgabe in mehreren Formaten (alle auf einmal, wenn Sie wollen). Ich in der Regel verwenden Sie zum generieren einer HTML-Handbuch.

    Doxygen ist in Erster Linie entwickelt, um Dokument-code, aber wenn Sie schreiben gerade eine standalone-Handbuch die Seiten - und Abschnitt - bezogene Befehle tun einen ziemlich guten job.

    Die Liste der Doxygen-Ausgabe-Formate ist hier.

    Details aus der Doxygen-Handbuch Seite:

    PDF:
    Generiert aus der LaTeX-Ausgabe durch die Ausführung make pdf im
    Ausgabe-Verzeichnis. Verbesserung der PDF-Ausgabe, die Sie normalerweise wollen würde
    aktivieren der Verwendung von pdflatex durch Einstellung USE_PDFLATEX JA in der
    Konfigurations-Datei. Um hyperlinks in der PDF-Datei, die Sie
    auch benötigen, um PDF_HYPERLINKS.

    Hinweis: Sie müssen einen TeX-setup zu verwenden. Doxygen nicht produzieren die erforderliche Leistung nur durch sich selbst, aber das gilt für Pandoc zu.

    Nein, ich wusste nicht, Sie könnte tun markdown. Ich denke, es ist relativ neu. Ich habe schon googeln um, aber niemand scheint so ein Beispiel-Befehl für die Konvertierung von markdown nach pdf. Bearbeiten können Sie ein Beispiel in Ihrer Antwort?
    Ist es das, was du wolltest? PS. gibt es links unter dem Worte 'hier' und 'Seite' - nicht sehr offensichtlich, in dieser schriftart.
    Danke für den edit. Ich von Ihnen positiv bewertet werden Ihre Antwort. Jedoch, würde ich mag, um zu sehen, den spezifischen Befehl relevant zu dieser Frage, wie auch, was bedeutet, konvertieren Markdown bis PDF. E. g. pandoc -f markdown -o test.pdf test.md für pandoc. Ich würde den Befehl mit einem Beispiel mich selbst, sondern für Doxygen ich kann nicht scheinen, um es zu finden; alle Beispiele scheinen zu beginnen LaTeX ausgegeben, als wenn ich konvertieren müssen Markdown zu LaTeX ersten. BTW, ich weiß nicht, wie pandoc Vanille funktioniert, aber mit dem Paket von Ubuntu funktioniert es sofort, keine Notwendigkeit zum hinzufügen von TeX-setup manuell.
    Doxygen verwendet eine config-Datei und nicht als Befehl Linie Parameter wie pandoc funktioniert. So, nachdem ich Doxygen, müssen Sie konfigurieren Sie die Datei "doxyfile" für GENERATE_LATEX = JA (und andere grundlegende Konfiguration, wie INPUT) und führen Sie dann doxygen doxyfile. Dies sollte generieren, die LaTeX von markdown. Ich bin auf Windows, sieht aus wie Ubuntu ist mehr set-up für diese Art der Sache (wenig überraschend).

    InformationsquelleAutor Cheeseminer

Schreibe einen Kommentar