Dokumentation im MarkDown schreiben - welches Programm?

Du suchst ein Programm für einen bestimmten Zweck?
Antworten
Benutzeravatar
ThorstenS
Beiträge: 2875
Registriert: 24.04.2004 15:33:31

Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von ThorstenS » 07.02.2015 10:58:15

Hi Leute,
ich schreibe immer mehr kurze Dokus mit haroopad, welches den markdown syntax live in HTML rendert.
Links der Editor, rechts die HTML Ansicht.

Jetzt möchte ich aber meine interne Doku (~120Seiten) von LibreOffice weg auf ein anderes Tool umziehen - idealerweise consolenbasiert aber zumindest im MarkDown Syntax. (Die Änderungen lassen sich mit git diff so schön anschauen und Gedankenblitze mit vim flott von überall einpflegen.)

Womit schreibt ihr eure Doku, was könnt ihr mir aus eurer Praxis heraus empfehlen? (Als Output wünsch ich mir html und pdf, ggflls epub).

mullers

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von mullers » 07.02.2015 13:24:19

Ich würde da pandoc oder orgmode/emacs nehmen. Pandoc [¹] natürlich auch kein Problem in vi.

http://johnmacfarlane.net/pandoc/

Benutzeravatar
ThorstenS
Beiträge: 2875
Registriert: 24.04.2004 15:33:31

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von ThorstenS » 07.02.2015 14:57:45

Danke, pandoc ist in der Tat DAS tool zum Konvertieren.

Ich such eher einen Editor, der mir em Ende auch mehrere Seiten/Dateien zusammenfassen kann - mit Verlinkungen von einem Kapitel zum anderen.

Haroopad zum Schreiben ist toll, aber Verlinkungen über mehrere Dokumente hinweg gehen damit nicht.
Flatdoc zum direkten Konvertieren (flatdoch.js + Datei.md = HTML5) im Browser scheint eine Lösung zu sein oder Daux.io für umfangreichere Projekte.

Aber so richtig überzeugen tut mich das noch nicht. Ich hab den Thread aufgemacht, weil ich hoffe jemand hier im Forum hat schon einen ausgeklügelten Workflow, den er/sie mir empfehlen kann. :)

mullers

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von mullers » 07.02.2015 19:10:55

pandoc nutze ich selbst auch nur zum Konvertieren. Aber ich hatte es erwähnt, weil man doch das MarkDown dauch selber schreiben und dann mit pandoc in das gewünschte Format exportieren kann.
Orgmode läuft halt am besten in Emacs und da ist die Exportfunktion gewaltig und in den Dateien kannst du wahlweise deine Großmutter oder deine Enkel verlinken oder was auch immer. :wink:

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
EDIT: Weil ich in diesem Thread so missverstanden wurde wie noch nie :wink:
1. Emacs/orgmode ist nur ein Hinweis für Leute, dies sowieso Emacs nutzen, weniger für den TS
2. Pandoc lass ich dann andere erklären, gibt ja genug im Netz dazu:
http://george.sudarkoff.com/markdown-pandoc-workflow/
http://stackoverflow.com/questions/4779 ... iple-files u.a.
Zuletzt geändert von mullers am 10.02.2015 09:30:53, insgesamt 2-mal geändert.

Benutzeravatar
ThorstenS
Beiträge: 2875
Registriert: 24.04.2004 15:33:31

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von ThorstenS » 10.02.2015 08:01:10

danke, aber in emacs arbeite ich mich nicht ein. Ich nutze seit viiiieln Jahren vim, dessen Bedienung ist mir in Fleisch und Blut übergegangen.
Vom orgmode hab ich schon viel gehört, der wird für dich sicherlich auch ein super Werkzeug sein.
---------------------------------------------------------------
Edit: Danke dir für die beiden Links. Speziell der zwote ist wertvoll!
Ich hab dich nicht falsch verstanden, tut mir leid, wenn das so rüberkam. Mein Text war wohl leider zu knapp, liegt daran, dass mich die Grippe niedergestreckt hat.

Gestern bin ich auch über diesen erhellenden Blogpost gestolpert:
http://www.freshthought.com/jenesuispas ... documents/

Für mich steht - auch dank deiner Antworten - fest, dass ich mit Markdown gut fahre. Mittels pandoc habe ich die Möglichkeit nach html|pdf|epub|usw. zu exportieren. Ich halte mir also alle Wege offen.
Die einzelnen Kapitel werde ich in eigene md-Dateien auslagern (mit haroopad schreibe ich die primär) und mit einem der oben verlinkten Hilfstools zusammenfassen lassen. Wie das mit internen Verweisen aussieht, muss ich noch erarbeiten.

Benutzeravatar
ThorstenS
Beiträge: 2875
Registriert: 24.04.2004 15:33:31

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von ThorstenS » 12.08.2015 15:44:35

An der Arbeit haben wir uns zu dritt dazu entschieden auf Debianpython3-sphinxzu setzen, weil der Output nach html, epub und pdf möglich ist.
Das ist zwar ein bischen Arbeit, aber das Ergebnis gefällt mir.

trickykid
Beiträge: 279
Registriert: 15.05.2003 12:37:06

Re: Dokumentation im MarkDown schreiben - welches Programm?

Beitrag von trickykid » 26.08.2015 16:34:43

EMACS ist nicht mehr zeitgemäss. :)

Ich schreibe alles was ich schriftlich produziere in html. Das ist einfacher und geht schneller als man denkt. Es werden nicht viele tags benötigt. Wenn ich viele Hyperlinks im Text habe dann nehme ich zur besseren Übersicht markdown. Je nach Gusto jage ich es danach durch pandoc.

Antworten