mirror of
https://github.com/sitn/sitn-docs.git
synced 2026-08-26 00:14:17 +00:00
SITN Web services documentation | Read-only mirror of https://github.com/sitn/sitn-docs — Canton de Neuchâtel. Issues & pull requests at the source.
- TypeScript 69.5%
- CSS 16.4%
- Python 8.5%
- Dockerfile 4.7%
- JavaScript 0.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .vscode | ||
| docusaurus | ||
| examples | ||
| .env.sample | ||
| .gitignore | ||
| deploy | ||
| docker-compose.yml | ||
| README.md | ||
Documentation SITN - website
This project is divided into 2 parts:
- docusaurus documentation
- live examples
Each part is managed separately by two distincts package.json
Run docusaurus
cd docusaurus
npm i
npm start
Run live examples
cd examples
npm i
npm start
Deploy
python deploy
Contribute
If you want to add a live-example to the documentation, best is to start in the examples directory:
- Create a folder containing your example
- Reference it in
/index.html - Reference it in
/vite.config.jsin theinputsection - Publish your code to GitHub and deploy examples container
- You are now able to include the github code in your markdown and a live exemple as an iframe