https://github.com/springwolf/springwolf.github.io
Documentation for Springwolf
https://github.com/springwolf/springwolf.github.io
Last synced: 5 months ago
JSON representation
Documentation for Springwolf
- Host: GitHub
- URL: https://github.com/springwolf/springwolf.github.io
- Owner: springwolf
- License: apache-2.0
- Created: 2021-12-02T19:28:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-13T13:35:12.000Z (9 months ago)
- Last Synced: 2025-06-26T22:06:19.398Z (8 months ago)
- Language: JavaScript
- Size: 3.34 MB
- Stars: 4
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Springwolf Website
[](https://github.com/springwolf/springwolf.github.io/actions/workflows/build.yml)
[](https://app.netlify.com/sites/springwolf/deploys)
Latest docs are deployed to
- [https://www.springwolf.dev](https://www.springwolf.dev)
- Fallback: [https://springwolf.github.io](https://springwolf.github.io)
## Updating the website & documentation
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The [docs](docs) folder contains all pages in Markdown format.
### Local Development
```bash
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.
```bash
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](https://vale.sh) tool is used to verify the language style.
After installing, verify the documentation with
```bash
vale sync
vale docs/
```
Words not part of the dictionary yet are added in [accept.txt](.github/styles/config/vocabularies/Springwolf/accept.txt).
## Run Markdown Linter
To validate that the created Markdown follows the rules:
```bash
npm run lint:md
```