Skip to content

hpi-schul-cloud/schulcloud-documentation

Folders and files

NameName
Last commit message
Last commit date
Oct 17, 2023
Feb 10, 2025
Sep 13, 2023
Nov 2, 2023
Nov 2, 2023
Oct 17, 2023
Sep 6, 2023
Dec 2, 2024
Oct 17, 2023
Oct 11, 2023
Sep 6, 2023
Sep 6, 2023

Repository files navigation

Website

This website is a documentation aggregator for all Schulcloud-Verbund software.

It is deployed at https://documentation.dbildungscloud.dev/

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

Installation

$ npm ci

Local Development

$ npm run 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.

Note that the search will only work with the build command.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Update the docs

Create a new branch. Change the /docs files.

Deployment

Create a pull request and once your changes are merged into main the website will automatically deploy the new version.

Important

Do not remove the branch gh-pages. This branch is auto generated and contains the hosted website.