MistServer documentation

This is the MistServer documentation, also available at https://docs.mistserver.org

A Docusaurus is used to generated static documentation pages from the MarkDown files.

Install

npm install

To run a local test version

npx docusaurus start --host 0.0.0.0 --port 3000

This will host the documentation (externally available) on http://localhost:3000

To build a static version

npx docusaurus build

This will create a build folder and compile the static pages

To serve the static version

npx docusaurus serve --port 3000

This will serve the build documentation on http://localhost:3000

Folder structure

Documentation pages will automatically get added through the structure available within docs. Docusaurus will automatically group MarkDown files within a folder into one category and structure them accordingly using the folder structure itself. Generally it is recommended to add a foldername.md within a folder so you can provide information to the category.

Every MarkDown file should start with a header file between single line --- for Docusaurus to properly name, tag and order. e.g.:

id: jwt
title: JSON Web Tokens
tags:
  - jwt
  - access
  - pushing
sidebar_position: 8
description: JWT support and MistServer

Linking between documentation pages is possible and should be done using the relative path to the linking .md file. e.g.: docs/mistserver/integration/jwt.md linking to the addjwks API call within docs/mistserver/integration/api/calls/ [addjwks]:./api/calls/addjwks.md Linking like this ensures the link will still work if page ids change.

Pictures should be added to static/img/ and linked from there. Since originally all pictures came from our old blog we've used static/img/blogs/ and kept using the blogs folder per category. This should probably be changed at some point.