Gå til hovedinnhold

Docusaurus tips

BLI MED PÅ DOKUMENTERINGSDUGNAD

Bli med på å utvikle

  • innholdet i dette dokumentet (README.md)
  • andre dokumenter i mappen docs/utviklerdokumentasjon/bruke_docusaurus
  • eller legg til nye dokumenter i samme mappe

Tips og triks lært underveis
Disse websidene er skrevet i Markdown-filer og generert av Docusaurus. Underveis har vi lært noe om hvordan utvikle disse dokumentene på best mulig måte, lærdom som kanskje eller er vanskelig å finne. La oss skrive ned slike tips og triks i dokumenter som vi legger i katalogen docs/bruke_docusaurus i fs-plattform-repoet.

Henvis gjerne til eksistende dokumentasjon på nettet, det kan være vanskelig å finne akkurat det man leter etter.

Hva er Docusaurus?

Docusaurus er et open-source-verktøy og et rammeverk for å bygge, vedlikeholde og distribuere nettstedet for dokumentasjon av prosjekter, spesielt for programvareutviklingsprosjekter og andre tekniske dokumentasjonsbehov. Det ble opprinnelig utviklet av Facebook og er tilgjengelig for allmennheten som et gratis verktøy.

Docusaurus gir en enkel og effektiv måte å organisere dokumentasjon, håndtere versjonshåndtering, og tilbyr en responsiv og brukervennlig nettside for dokumentasjonsformål. Rammeverket er bygget på toppen av moderne teknologier som React.js for brukergrensesnitt og Markdown for å skrive dokumenter.

...

Docusaurus har blitt populært blant utviklingsfellesskapet, spesielt innenfor Open Source-prosjekter, da det gir en praktisk måte å presentere og vedlikeholde dokumentasjonen for prosjekter på en effektiv måte. Det lar utviklere fokusere mer på innholdet og mindre på infrastrukturen rundt dokumentasjonssiden.

(Tekst generert av ChatGPT på spørsmålet 'Hva er Docusaurus?' - 03.08.2023)

Hva er Markdown?

Markdown is a plain text formatting syntax designed so that it can be converted to HTML using a tool by the same name.

(fra: Stack Overflow)

Docusaurus- og Markdown-dokumentasjon​

Docusaurus og Markdown er godt dokumentert.

Docusaurus

Markdown