-
Notifications
You must be signed in to change notification settings - Fork 52
Endringslogg
Aktiverte brødsmulevisning. Fantes i docs frå før, me var berre deaktivert.
Når ein lenka til eit anker på ei side, så havna ein under tittelen til ankeret istadenfor akkurat på ankeret, slik at det blir litt vanskelig å forstå kontekst. La til ein scroll-padding offset i CSS for å fikse dette. Og styla også table of contents i toppen slik at den fekk litt meir luft.
Endring i innebygd søk som var implementert i Digdir Docs. "lunr" var opprinnelig i bruk, men det er problem med pre-indeksering client-side. Erstattet med SimpleJekyllSearch, som pre-indekserer dokumenter og produserer raske svar tilbake ettersom det vil skje på klienten.
På grunn av den utrolige store mengden intern-linking av dokumenter i repoet “docs.digdir.no” så måtte det skrives en algoritme som kunne ta for seg dette på en automatisk måte.
Måten dette er gjort på er å ta for seg alle markdown og HTML-filer, og matche disse mot eksisterende “permalink”-attribute for så å finne hvilken fil som det er blitt referert til. Deretter så blir eksisterende link endret til å prepende “{{site.baseurl}}”, som refererer til root, og faktisk relativ URL til filens lokasjon. Dette gjør det mer fleksibelt på sikt dersom man endrer oppsett av siden.
Tidligere ble alle sider publisert til root-mappa, men nå er de kompilert ut til de respektive mappene de ligger i. På denne måten slipper man å inkludere “permalink” i alle front matters, og heller bruke lokasjonen til filene.
Fremtidig er det viktig å refere til relative URLer da ikke lengre filene ligger i root-mappa.
Eksempel på linking av nytt dokument:
- Oppretter nytt dokument i folder “docs -> maskinporten -> test.md”
- Internlenke blir da “{{site.baseurl}}/docs/maskinporten/test”
Det er også lagt inn redirecting av gamle permalinks, slik at eksterne som har linket til siden kommer automatisk til ny URL. Dette er gjort ved å bruke en plugin som heter “jekyll-redirect-from”, og med egen front-matter attribute som heter “redirect_from”. Denne forteller siden at alle requests med gammel URL skal pekes til ny side automatisk.