README.md

SharingHub Docs

Table of contents

• Development
  • Environment setup
  • Serve
• Production
  • Local build
  • Docker image

Development

Environment setup

Python 3.11 required.

Setup the environment:

python -mvenv .venv
source .venv/bin/activate
pip install -r requirements.txt

Install the pre-commit hooks:

pre-commit install --install-hooks

Serve

Edit the docs and update it live with MkDocs:

mkdocs serve

Production

Local build

Build the docs with:

mkdocs build

Docker image

Build the image with:

docker build . -t sharinghub-docs --build-arg VERSION=$(git rev-parse --short HEAD)

Run it locally with:

docker run --rm -p 5000:80 --name sharinghub-docs sharinghub-docs:latest

Copyright and License

Copyright 2024 CS GROUP - France

SharingHub Docs is an open source software, distributed under the Apache License 2.0. See the LICENSE file for more information.