https://github.com/cble-platform/docs
CBLE documentation
https://github.com/cble-platform/docs
docs github-pages mkdocs
Last synced: 5 months ago
JSON representation
CBLE documentation
- Host: GitHub
- URL: https://github.com/cble-platform/docs
- Owner: cble-platform
- Created: 2023-08-28T02:24:13.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T01:41:11.000Z (about 2 years ago)
- Last Synced: 2024-04-25T23:55:46.658Z (about 2 years ago)
- Topics: docs, github-pages, mkdocs
- Language: CSS
- Homepage: https://docs.cble.io/latest/
- Size: 1.73 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CBLE Documentation
[](https://github.com/cble-platform/docs/actions/workflows/build-docs.yml)
This documentation is built with `mkdocs` and uses [Poetry](https://python-poetry.org/) for dependency management.
## Prerequisites
- [Poetry](https://python-poetry.org/docs/#installation)
- Python `^3.11`
## Building
To build the site locally, just run `mkdocs build` and the static site will be generated in the `site` folder.
## Deployment
This site is using versioned documentation with [mike](https://github.com/jimporter/mike).
> ⚠️ To deploy a new version, **merge all changes into `main` first**
```shell
git switch main
mike deploy -t "x.x (latest)" x.x latest
mike serve
# Check to ensure generated site is good to go
git switch gh-pages
git push
git switch main
```
## Development
Ensure you have the [prerequisites](#prerequisites) installed and then run the dev server using `mkdocs serve`.