Markdown in Mou op OS X

Samenwerken met meerdere auteurs aan een e-book met Markdown en Dropbox

Samen met Frank Meeuwsen en Oskar van Rijswijk schreef ik het e-book “Lifehacking met Evernote”. We zijn begonnen met een inventarisatie van wat we wilden vertellen. Daar hebben we een hoofdstukindeling uit gedestilleerd waarna we de hoofdstukken onderling hebben verdeeld.

Het grootste deel van het werk is vervolgens met Evernote zelf uitgevoerd. Door per hoofdstuk een tekstbestand aan te maken en dat via Evernote te synchroniseren. Na de review van elkaars teksten bleek het samenvoegen van alle tekstbestanden en afbeeldingen tot een net e-book een dag werk te zijn. Ook bleken sommige tekens zoals aanhalingstekens en quotes problemen op te leveren waardoor we daar steeds rekening mee moesten houden. Dit waren voor mij genoeg redenen om het samenstellen van het boek te automatiseren.

Uiteindelijk hebben we met onderstaande tools gewerkt:

  • Markdown Markdown is een opmaaktaal die je gemakkelijk kunt lezen én schrijven. Het idee van bedenker John Gruber is dat je aan platte tekst opmaak mee kunt geven zonder de leesbaarheid van de platte tekst te verstoren.
  • Evernote In Evernote zelf hebben we drie notitieboeken gedeeld: een met tientallen notities (een notitie per hoofdstuk), een voor de organisatie met schrijfafspraken, ideeën, input van lezers en to-do’s, en een als collectie van interessante artikelen. In de notities van de hoofdstukken hebben we elkaar ook tips en feedback gegeven.
  • Asana Na de lancering van het boek zijn we voor ideeën, to-do’s, tips en feedback overgestapt op Asana. Zo staat alles wat we nog willen doen op één plek en raakt niets ondergesneeuwd in e-mailberichten, tweets of berichten op Google+. In Asana delen we een workspace waarin de taken zijn onderverdeeld in projecten per update of los te benoemen onderdeel.
  • Dropbox Bestanden die je in je Dropbox plaatst zijn via internet (“the cloud”) toegankelijk op al je computers. Je kunt de bestanden ook delen met anderen.
  • Pandoc Pandoc van John MacFarlane is een zwitsers zakmes om bestanden naar een andere opmaaktaal om te zetten. Bijvoorbeeld van Markdown naar HTML, EPUB, docx (Microsoft Office), MediaWiki of PDF (via LaTeX). Je kunt met Pandoc artikelen of boeken schrijven en slides voor een presentatie genereren. Met Calibre zou je ook een eind moeten komen alleen kreeg ik de afbeeldingen al niet voor elkaar.
  • KindleGen Kindlegen is een officiële tool van Amazon om (X)HTML en EPUB-bestanden naar KF8/MOBI te converteren – om te gebruiken op de Kindle. Pandoc converteert niet rechtstreeks naar MOBI dus daar is deze extra tool voor nodig.
  • Script Om de tientallen Markdown-bestanden met een druk op de knop binnen 15 seconden om te zetten naar e-books in PDF, EPUB en MOBI heb ik een script geschreven. Geïnspireerd door het principe van Daily Builds van Joel Spolsky. Zo kunnen we snel kleine wijzigingen doorvoeren. Bovendien leveren we het boek een aantal keren op – steeds met extra hoofdstukken – en denken we aan een reeks boeken in de serie “Lifehacking met …”.

In dit artikel licht ik Markdown en Dropbox toe, in een ander artikel hoe je geautomatiseerd een e-book kunt maken in PDF, EPUB en MOBI maken met Markdown, Pandoc en een script.

Markdown als opmaaktaal

Met de opmaaktaal Markdown kun je platte tekst opmaak meegeven zonder de leesbaarheid te verstoren. Markdown is gemakkelijker te leren en lezen dan HTML omdat het aansluit bij wat je toch al zou doen als je opmaak mee wilt geven. Linkjes en afbeeldingen moet je even aanwennen, de rest is erg eenvoudig.

Hieronder som ik de meest gebruikte elementen op, wij hebben hier ons boek mee kunnen schrijven.

  • # Kopjes Begin de regel met een hekje (#) – of onderstreep de tekst op de volgende regel met is-gelijk- of mintekens (= / -). De titel van een document kun je onderstrepen met = en de kopjes van het tweede niveau met -. Gemakkelijker te onthouden is # en ## die verder gaan tot niveau zes (######).
  • *Cursief* Zet één sterretje (*) of underscore (_) om een tekst heen.
  • **Vet** Zet twee sterretjes (**) of understores (__) om een tekst heen
  • * Opsomming Begin de regels met sterretjes (*), plus- of mintekens (+ / -). Om een alinea onder een opsomming te hangen spring je in met tab (of vier spaties). Om een opsomming in een opsomming te maken begin je een ingesprongen regel weer met een van de opsommingstekens.
  • 1. Numerieke opsomming Begin de regels met een getal met een punt erachter. De getallen hoeven niet eens oplopend te zijn – je mag de tel kwijt raken.
  • > Quotes Begin de regel met een groter dan teken (>).
  • `Programmeercode` Omsluit code in een zin met backticks (`). Een of meerdere alinea’s begin je met tab (of vier spaties).
  • Linkjes [te onderstrepen tekst](http://linkje.nl/ “Tooltip van de link”).
  • Afbeeldingen ![Alternatieve tekst voor de afbeelding](/pad/naar/afbeelding.jpg “Tooltip van de afbeelding”) Pandoc zet de alternatieve tekst voor de afbeelding om naar een bijschrift.
  • Horizontale lijn Zet drie of meer sterretjes, streepjes of underscores op één regel.

Tips:

  • Heb je in Markdown gebruikte tekens nodig in je tekst? Zet er een backslash (\) voor (het ‘escape character’).
  • Je kunt in een tekst ook gewoon HTML gebruiken, bijvoorbeeld om een tabel in te voegen.
  • Zorg dat je aan het einde van het bestand een lege regel hebt staan. Pandoc maakt anders geen volgend hoofdstuk aan. De ontwikkelaar van Pandoc wijst op het goede gebruik een tekstbestand met een lege regel af te sluiten.
  • Raadpleeg voor meer tips de Markdown Syntax.

Sinds ik Markdown heb leren kennen schrijf ik alle teksten erin. HTML kan ik ook uit het hoofd maar is omslachtiger omdat je met tags werkt die je ook nog eens moet openen en sluiten. Markdown is door een computer eenvoudig om te zetten in het meer ingewikkelde HTML en steeds meer programma’s ondersteunen dat dan ook.

Als je net met Markdown begint dan is het fijn om direct te zien of je tekst goed wordt opgemaakt. Kies dan een editor die in een gesplitst scherm het resultaat weergeeft zoals onderstaand screenshot van dit hoofdstuk. Markdown in Mou op macOS

Hieronder staan de Markdown-editors die ik heb gebruikt:

  • Windows: MarkdownPad
  • macOS: MacDown
  • Webbrowser: Markable (kan onder andere importeren van en exporteren naar Dropbox en Evernote).
  • iOS: iA Writer, Writing Kit en Drafts kunnen overweg met Markdown, Dropbox en Evernote. Een preview krijg je niet live maar zit twee tikjes verderop.

Dropbox om bestanden te delen

Met Dropbox zet je je bestanden “in the cloud” en kun je ze delen met anderen. Dit kan ook via een notitie in Evernote en zo zijn we natuurlijk in eerste instantie ook begonnen. Voor het e-book “Lifehacking met Evernote” bewaarden we de Markdown-teksten per hoofdstuk in een bestand. In Evernote hebben we een notitieboek voor het e-book met per hoofdstuk een notitie. In deze notitie bewaarden we de Markdown-bestanden met de extensie .md, plus de afbeeldingen. Direct vanuit Evernote kun je deze bestanden openen in een Markdown-editor en weer opslaan. Eventuele feedback en aanvullingen op elkaars teksten konden we ook handig in de notitie van het hoofdstuk kwijt.

Vanaf de volgende fase in het project – het samenvoegen van alle bestanden tot één e-book – zijn we overgestapt op Dropbox omdat we anders steeds de bestanden los uit Evernote zouden moeten halen. Bestanden en mappen die je in Dropbox zet kun je ook op al je machines benaderen – en delen met anderen. Een van de auteurs deelde via de webinterface van Dropbox de map met de andere auteurs. Sindsdien zijn de Markdown-teksten en afbeeldingen in Evernote gebleven en in principe hadden ze daar ook van meet af aan kunnen staan.

Gebruik je nog geen Dropbox? Je kunt nu een gratis Dropbox-account aanmaken met 500 MB extra schijfruimte (totaal 2,5 GB). Door zelf weer anderen uit te nodigen voor Dropbox kun je daar gratis 18 GB van maken.

Dropbox previous versions

Een voordeel van Dropbox ten opzichte van Evernote voor het werken met bestanden is dat je met Dropbox iedere wijziging terug kunt draaien. Na het selecteren van een bestand kun je via More > Previous versions voorgaande versies inzien en ervoor kiezen om de huidige versie te overschrijven met een oudere versie. Evernote bewaart iedere acht uur een nieuwe versie als een notitie is gewijzigd.

Geef een reactie

Je reactie verschijnt pas na goedkeuring. Je e-mailadres wordt niet gepubliceerd. Vereiste velden zijn gemarkeerd met *