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%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
maltaesousa 0f0c816fab update doc
2026-02-20 16:49:17 +01:00
.vscode init 2024-08-19 11:39:51 +02:00
docusaurus update doc 2026-02-20 16:49:17 +01:00
examples Added STAC batch download python script 2025-03-03 15:18:14 +01:00
.env.sample Update broken path, removed quotes in .env.sample file, and update docusaurus 2024-12-17 10:58:21 +01:00
.gitignore deploy script 2024-11-08 09:26:56 +01:00
deploy deploy script 2024-11-08 09:26:56 +01:00
docker-compose.yml getfeatureinfo 2024-11-08 09:09:34 +01:00
README.md deploy script 2024-11-08 09:26:56 +01:00

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:

  1. Create a folder containing your example
  2. Reference it in /index.html
  3. Reference it in /vite.config.js in the input section
  4. Publish your code to GitHub and deploy examples container
  5. You are now able to include the github code in your markdown and a live exemple as an iframe