Gå til indholdet

Home

Grunderna i DF

Välkommen till vår nya wiki!

Innehållsförteckning

Kuriosa och onödigt

Gammal ingångssida, här är ingångssidan från den gamla wiki:n, alla undersidor finns tillgängliga i exporterat format i /var/www/oldwiki_pageselaine.

Citatboken, här kan man spara kloka ord eller okloka ord från medlemmar.

Hur funkar sidan?

Sidan är skapad i MkDocs med temat mkdocs-material.

TIPS: Det finns några tangentbordsgenvägar inbyggt i sidan, se här.

Prova exempelvis:

  • f , s , / : open search dialog
  • p , , : go to previous page
  • n , . : go to next page

Bidra till wikin

Denna sida är ett git-repo, vilket betyder att du kan skapa pull-requests med innehåll som du tycker skulle passa in!

Installera mkdocs på egen maskin

mkdocs är skriver i python så du lär vilja använda venv och uv

git clone gitea@git.dflund.se:df/df-docs.git
uv venv
source ./venv/bin/activate
uv pip install mkdocs mkdocs-material
mkdocs serve

Previewing as you write

MkDocs includes a live preview server, so you can preview your changes as you write your documentation. The server will automatically rebuild the site upon saving. Start it with:

mkdocs serve
  1. If you have a large documentation project, it might take minutes until MkDocs has rebuilt all pages for you to preview. If you're only interested in the current page, the --dirtyreload flag will make rebuilds much faster:
mkdocs serve --dirtyreload

If you're running Material for MkDocs from within Docker, use:

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Building your site

When you're finished editing, you can build a static site from your Markdown files with:

mkdocs build

If you're running Material for MkDocs from within Docker, use:

docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build