05 June 2019

Van tekst naar website

Ik schrijf mijn teksten voor deze website in Asciidoc [1]. Op mijn HDD’s en NAS' staan bestanden met tekst uit een al dan niet ver verleden in diverse formaten. Word, Openoffice, HTML, TXT, Markdown. Die zet ik met Pandoc naar behoefte om in Asciidoc en werk er dan verder mee in VCS.

Tekst editor

Ik gebruik Visual Studio Code (VCS) als 'editor of choice' met daarin de extensies Gitlens en Git History. Beide extensies maken het werken met GIT in VCS eenvoudiger.

Voor publicatie van de Asciidoc-bestanden gebruik ik JBake die er een statische website van maakt.

Experimenteren

Versioning in VCS
VCS diff

Git gebruik ik om veranderingen in bestanden bij te houden. Met ondersteunende software. En daarmee een welkome aanvulling op mijn geheugen..

Asciidoc geeft o.a. de mogelijkheid om content van andere bestanden op te nemen [2]. In dergelijke gevallen ben je niet met 1 bestand bezig, maar met 2 of meer tegelijk.

GIT

VCS

Voor een niet-coder zoals ik kost het tijd om te begrijpen wat Git is. En op welke manier het te gebruiken is bij 'versie controle' van teksten [3].

In de praktijk ben ik met meerdere bestanden tegelijk bezig. Sommige worden geschreven in 1 of 2 dagen, andere worden samengesteld in de loop van weken. Soms maanden. Dat geldt met name voor teksten die ik schrijf in relatie tot mijn stamboom-onderzoek. Alle teksten waar ik actief mee bezig ben of klaar zijn, staan in een directory structuur. Met Git maak je daar een 'snapshot' van. Daarna wordt elke verandering in die structuur bijgehouden.

Sourcetree

git 03
Figure 1. sourcetree

Voor een makkelijker te begrijpen overzicht van de GIT-status van de actieve bestanden gebruik ik Sourcetree. Een grafische schil rond Git .

Met Sourcetree wordt voor beginners het gebruik van Git wat eenvoudiger.

In figuur 4 linksonder een lijstje met bestanden die nieuw of veranderd zijn binnen de directory structuur. Rechts een overzicht wat er is veranderd aan het aangeklikte bestand.

Bitbucket

Op dit moment gebruik ik Bitbucket hoofdzakelijk als een backup van de lokale GIT. Ik koos Bitbucket omdat je content hier 'private' kan worden geplaatst. Bij de gratis versie van het bekendere Github is dat niet mogelijk.

Van de bestanden in je directory structuur (content) wordt een versie op Bitbucket bijgehouden. Wanneer en wat is veranderd (commits) eveneens. Desgewenst kunnen 'issues' worden aangemaakt. Ik denk erover om dat te gebruiken voor research voor artikelen in relatie tot stamboom onderzoek.

git 05
Bitbucket commits
git 06
Bitbucket content
git 07
Bitbucket issues
Software voor mijn schrijfwerk

Asciidoctor

Windows /Linux

A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more.

Visual Studio Code met Gitlens en Git History

Windows /Linux

Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop.
GitLens supercharges the Git capabilities built into Visual Studio Code.
Git History, Search and More (including git log)

Pandoc

Windows

a universal document converter

JBake

Windows

JBake is a Java based, open source, static site/blog generator for developers & designers

Hugo

Windows

Hugo is a popular open-source static site generator.

GIT

Windows /Linux

Git is a free and open source distributed version control system

Gitlab

Windows /Linux

GitLab is the open DevOps platform. An application for collaboration, visibility, and development velocity.

Sourcetree

Windows

A free Git client for Windows and Mac. Visualize and manage your repositories through Sourcetree’s simple Git GUI.

Gitbash

Windows

BASH emulation used to run Git from the command line.


1. http://asciidoc.org/ - AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.
3. Een goed boek voor het leren van GIT is Pro Git book, geschreven door Scott Chacon and Ben Straub.