Referere én markdown‑fil fra en annen markdown‑fil

Dokumentasjonsseksjonene i utviklerportalen fungerer som et speil av docs‑repoet ditt i Milliways / HelseGitLab. Det betyr at du kan referere til andre filer akkurat som du ville gjort i et vanlig filsystem eller git‑repo.

For å referere til en annen fil i docs‑repoet ditt, kan du bruke én av følgende metoder:

Absolutt URL

En absolutt URL kan brukes for å peke direkte på et annet dokument og inkluderer hele adressen, inkludert domenet. Dette fungerer ikke på tvers av ulike miljøer (prod, test osv.). Hvis du vil ha lenker som virker både i produksjon og test, bør du bruke relative eller absolutt‑relative URL‑er i stedet.

Eksempel på en absolutt URL til dette dokumentet:

https://utviklerportal.nhn.no/informasjonstjenester/plattform/utviklerportal/dokumentasjon/docs/developers/how-to-reference-other-filesmd

Absolute-relative URL

An absolute-relative URL will start from the domain root (www.utviklerportal.nhn.no/). This way of writing URLs will ensure your links are environment-agnostic, reducing the risk of faulty links and need for maintenance between different environments.

Example of an absolute-relative URL to this document:

/informasjonstjenester/plattform/utviklerportal/dokumentasjon/docs/developers/how-to-reference-other-filesmd

Merk: Dette virker ikke i readme.md‑filer som blir rendert når du klikker på en mappe (f.eks. i docs‑mappen). I sånne tilfeller bør du bruke relative URL‑er som beskrevet nedenfor.

Relative URL

Når du arbeider med markdown‑filer i et docs‑repo som speiles i Utviklerportalen, har du også muligheten til å bruke relative URL‑er. En relativ URL starter fra den aktuelle dokumentets plassering, så den er helt uavhengig av miljø og vil fungere i alle miljøer så lenge fil‑ og mappestrukturen holdes lik.

Eksempel: relativ URL til et dokument i samme katalog

Anta at du befinner deg i filen docs/developers/how-to-reference-other-files.md og ønsker å lenke til readme.md som ligger i samme katalog.

[Link til README i samme mappe](./readme.md)

``
./readme.md
``

Eksempel på relativ URL til et dokumentet en et søsken området:

``
../editors/readme.md
``