-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f2ec9c9
commit 2e6ea41
Showing
1 changed file
with
4 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,14 @@ | ||
# IoT Hub Portal Documentation | ||
|
||
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/CGI-FR/IoT-Hub-Portal/tree/docs/main) | ||
|
||
## Quick start | ||
|
||
> The documentation of IoT Hub Portal is based on [https://squidfunk.github.io/mkdocs-material](mkdocs-material). | ||
## Configure dev environment | ||
|
||
To install mkdocs-material and required dependencies, you have to run the following command at the root of the project: | ||
|
||
```console | ||
pip install -r requirements.txt | ||
``` | ||
To contribute to IoT Hub Portal's documentation: | ||
|
||
After the installation python dependencies, your can start a local review of documentation site by the following command at the root of the project: | ||
- Solution 1: Open this branch on Codespace | ||
- Solutuion 2: Open this branch on a devcontainer using VS Code. | ||
|
||
```console | ||
mkdocs serve | ||
``` | ||
On both solutions, a pre-configured development environment will be built, and the documentation website will be run and opened on an embedded browser. |