Tilpasning af HedgeDoc

For at tilpasse applikationen klonede jeg HedgeDocs repository fra GitHub og foretog en række ændringer i kildekoden.

Links åbner i samme fane: HedgeDoc anvendte target="_blank" på links, hvilket jeg finder unødvendigt i mange situationer. Jeg foretrækker at lade brugeren bestemme, om et link skal åbnes i en ny fane.

Forbedret Table of Contents: Jeg opdaterede stylingen af indholdsfortegnelsen, da standarddesignet efter min vurdering kunne forbedres betydeligt.

Servering af billeder via Nginx: HedgeDoc serverede billeder gennem Node.js, hvilket i min opsætning var langsomt og gav problemer med visning af billeder i fuld størrelse. Derfor konfigurerede jeg en separat Nginx-container til at håndtere billederne direkte.

Disse ændringer gav mig samtidig mulighed for at arbejde mere indgående med HedgeDocs kildekode og den underliggende serveropsætning.

Det startede med OSINT

Oprindeligt brugte jeg HedgeDoc til kollaborativ redigering af OSINT-noter (Open Source Intelligence) i Markdown. Mere specifikt arbejdede jeg sammen med en anden teknisk interesseret person om at dokumentere og undersøge misinformation, som vi havde fulgt gennem flere år.

Vores fund er blandt andet blevet delt med Zetland, som har anvendt materialet i deres arbejde.

Min interesse for at dokumentere og afdække misinformation opstod under coronapandemien, hvor jeg samarbejdede med en anden nørd på internettet om at undersøge en bestemt påstand, der gik viralt internationalt og tilsyneladende dannede grundlag for en række andre påstande.

I dag er jeg ikke længere særligt engageret i den slags undersøgelser privat, men jeg kunne godt se mig selv arbejde med OSINT på et mere professionelt niveau.

HedgeDoc til noter og dokumentation

HedgeDoc viste sig hurtigt at være mere avanceret og anvendelig end Nextcloud Notes, som jeg tidligere havde benyttet.

Derfor begyndte jeg at bruge min egen HedgeDoc-instans som en privat vidensbase med tekniske noter, konfigurationsvejledninger og dokumentation af mine forskellige projekter, herunder Beamtic og mit Docker-miljø.

Både jeg selv og enkelte venner har adgang til instansen med hver deres konto, hvilket også gør den anvendelig til fælles dokumentation.

Profundarium – fra Markdown til server-rendered HTML

Selvom HedgeDoc er velegnet til at skrive og organisere noter, synes jeg ikke, at den almindelige visning er optimal til offentlig dokumentation. Jeg ønskede en mere enkel og læsevenlig præsentation af mine noter, som samtidig kunne indekseres af søgemaskiner og udskrives uden unødvendige UI-elementer.

Derfor udviklede jeg Profundarium, en selvstændig applikation bygget med PHP og Laravel, som henter Markdown-dokumenter fra HedgeDoc og renderer dem som almindelig HTML på serveren.

Profundarium fungerer som et separat visningslag oven på HedgeDoc. Jeg kan fortsat skrive og redigere mine noter i HedgeDoc, men offentligt tilgængelige dokumenter kan præsenteres gennem Profundarium uden selve HedgeDocs brugerinterface.

Projektet omfatter blandt andet følgende funktioner:

• Server-side rendering: Markdown konverteres til HTML på serveren, så dokumenterne kan vises som almindelige websider.
• SEO: Dokumenterne får en mere søgemaskinevenlig præsentation, og det er muligt at styre indeksering gennem metadata.
• Print og PDF: En separat styling gør dokumenterne velegnede til udskrivning eller eksport til PDF gennem browseren.
• Automatisk omskrivning af links: Interne HedgeDoc-links kan omskrives, så de i stedet peger på den tilsvarende side i Profundarium.
• Understøttelse af billeder: Profundarium håndterer blandt andet HedgeDocs særlige syntaks til angivelse af billedstørrelser.

Applikationen henter dokumenterne direkte fra HedgeDoc og kræver hverken sin egen database, Node.js eller et separat frontend-build. Det gør den relativt enkel at vedligeholde og integrere i eksisterende servermiljøer.

Profundarium er udviklet og testet i mit Docker-baserede udviklingsmiljø Sandboxer, men kan også køres selvstændigt med PHP og Composer.

En vigtig del af projektet har været at holde arkitekturen enkel og adskille ansvaret mellem de forskellige komponenter. HedgeDoc håndterer redigering og opbevaring af noter, mens Profundarium udelukkende står for præsentationen af offentligt tilgængelige dokumenter.

Resultatet er en løsning, hvor jeg kan vedligeholde min dokumentation ét sted og samtidig præsentere udvalgte noter som almindelige websider.

Projektets kildekode ligger offentligt på GitHub, og en fungerende installation kan ses på hedgedoc.beamtic.net/profundarium.

Fortæl os hvad du tænker: