Springwolf Website

Latest docs are deployed to

• https://www.springwolf.dev
• Fallback: https://springwolf.github.io

Updating the website & documentation

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

The docs folder contains all pages in Markdown format.

Local Development

npm install

Make sure that you have installed all the dependencies in your local environment. You only need to run this command the first time or after dependencies are updated.

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.

Language Style

The vale tool is used to verify the language style. After installing, verify the documentation with

vale sync
vale docs/

Words not part of the dictionary yet are added in accept.txt.

Run Markdown Linter

To validate that the created Markdown follows the rules:

npm run lint:md