Gå til hovedinnhold

Skjule innhold

Når man skriver dokumentasjon, kan det være godt å skjule innhold inntil man er ferdig til å publisere. Dette dokumentet beskriver noen måter å skjule tekst, dokument eller katalog. Tekst, dokument eller katalog vil være helt skjult for leseren, men vil være synlig for de som har tilgang til docs-katalogen i fs-plattform repoet.

Fordeler ved dette:

  • Man kan unngå at duplisere innhold, dvs. man blir oppmerksom på hva som er under utvikling selv om det er skjult for sluttbruker.

  • Man kan rulle ut dokumentasjon selv om man ennå ikke er ferdig med alt. Dette kan brukes i trunk-based utvikling hvor main-branchen endrer seg ofte - man får hyppige merge av små endringer uavhengig om publiseringstakt.

  • Man kan bruke skjult tekst som kommentarer til andre dokumentasjonsutviklere.

Skjule tekst​

For å skjule tekst kan man bruke ** [ ]: # ** rundt teksten man vil skjule.

[
    Denne teksten er skjult
    
    (Grunnen til at denne teksten vises likevel er at hele denne tekstblokken  
     er omsluttet av ``` ``` for å kunne vises)
]: #

Tekst omsluttet på denne måten, vil kun synes som "kildekode". Teksten vil ikke vises i nettleseren, ikke engang ved 'Vis sidekilde'. Dette kan da brukes til å

  • lage skjulte kommentarer
  • skjule tekst inntil man anser den som ferdig
tips

markdownguide.org/hacks/#comments

Skjule dokument​

Et dokument kan skjules

  • Legg inn draft: true i metadata feltet - disse dokumentene vil bare være tilgjengelige i utviklingsmiljøet.'
  • eller ved å legge inn følgende linje i metadata-seksjonen i dokumentet man ønsker å skjule:
    sidebar_class_name: hidden
    Dette fungerer fordi følgende css-klasse er lagt til i 'fs-plattform/docusaurus/src/css/custom.css'
    .hidden { display: none !important; }

Skjule et dokument for routes fra et annet dokument​

Dersom du vil hindre muligheten for å kunne bla tilbake til forrige dokument eller frem til neste dokument med "Previouse" eller "Next" og slik eksponere et dokument du ønsker å ha skjult, kan du hindre det ved å en navnendring av det aktuelle dokumentet hvor man legger inn i starten av navnet, tegnet 'underscore': _

  • 'dokument.md' vil kunne finnes ved å bla fram eller tilbake med "Previous" eller "Next"
  • '_dokument.md' vil ikke kunne finnes ved å bla fram eller tilbake med "Previous" eller "Next"

Skjule katalog​

En katalog vil komme til syne dersom den har en README.md fil. Dersom man ønsker å skjule katalogen

  • kan legge inn sidebar_class_name: hidden i metadata-seksjonen i katalogens README.md-fil.
    Dette vil kun fungere dersom katalogen har flere dokumenter og ikke bare README.md