https://github.com/incendo/cloud-docs
Documentation for Cloud v2
https://github.com/incendo/cloud-docs
Last synced: about 1 year ago
JSON representation
Documentation for Cloud v2
- Host: GitHub
- URL: https://github.com/incendo/cloud-docs
- Owner: Incendo
- License: mit
- Created: 2023-11-27T16:51:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T19:37:55.000Z (over 1 year ago)
- Last Synced: 2024-12-30T20:30:09.986Z (over 1 year ago)
- Language: Java
- Homepage: https://cloud.incendo.org
- Size: 1.11 MB
- Stars: 5
- Watchers: 2
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cloud-docs [](https://cloud.incendo.org/en/latest/?badge=latest)
Documentation for Cloud v2.
The docs are written in markdown using [MkDocs](https://www.mkdocs.org/).
The docs are automatically built & deployed when pushing to the `main` branch and the docs are available on [cloud.incendo.org](https://cloud.incendo.org).
Each PR will deploy a temporary preview version of the site.
## Install & Build
You can install MkDocs by using
```shell
$ python3 -m pip install -r docs/requirements.txt
```
and then you may run MkDocs locally using
```shell
$ python3 -m mkdocs serve
```
after which the docs will be available at `http://127.0.0.1:8000/`.
The built site will auto-refresh when the files are updated.
### Prettier
We use prettier to validate the files when building the project.
It is recommended that you install prettier and run it when you make changes.
You can find instructions [here](https://prettier.io/docs/en/install).
You may also install prettier & husky using npm, which will also add a pre-commit hook
which formats the files for you:
```shell
$ npm install
```
then you may run prettier using:
```shell
$ npx prettier . --write
```
### Snippets
The `code` directory contains a Gradle project with compiled examples.
Snippets from these docs are used in the examples using the `{{ snippet("File.java") }}` macro.
The project will be built by the CI pipeline to validate that the snippets compile.