Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.56 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.56 KB
Raw

Bidra med dokumentasjon

Nettsiden lages basert på strukturen under docs/ mappen. For å legge inn informasjon om en ny tjeneste:

  1. Lag en ny mappe med et hensiktsmessig navn under /docs for den nye tjenesten.
  2. Lag en index.md fil under den nye mappen. Dette blir landingssiden for det nye området.
  3. Legg til flere markdown filer for hver separat side dere ønsker å vise.
  4. Oppdater sidebars.js hvis det er lagt til nye sider, slettet gamle sider, eller de har endret navn.
  5. Oppdater GitHub siden med filendringene.

GitHub Actions sørger for at endringer i master blir deployet til gh-pages branchen og da til GitHub Pages. Den bruker yarn.lock for å hente pakker, som er lagt til i .gitignore. Hvis man skal oppdatere versjoner må man lage en package-lock.json fil med internt pakkeregister og yarn.lock med eksternt.

Development

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Manual Deployment

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.