-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a readme for the documentaion start.
- Loading branch information
Showing
1 changed file
with
31 additions
and
1 deletion.
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,4 +1,34 @@ | ||
# kc-config-cli | ||
# Set-up to install and get start with documentation in Keycloak config cli | ||
|
||
- Make sure to have python installed. | ||
|
||
On MAC | ||
``` | ||
sudo apt install python3.8 | ||
``` | ||
|
||
On Ubuntu | ||
```Bash | ||
brew install [email protected] | ||
``` | ||
|
||
- Create the virtual environment in the root directory of your project. | ||
```Bash | ||
python3 -m venv venv | ||
``` | ||
|
||
- Activate the virtual environment | ||
```Bash | ||
source venv/bin/activate | ||
``` | ||
|
||
- install the requirements needed | ||
``` | ||
pip install mkdocs-material | ||
pip install "mkdocs-material[imaging]" | ||
``` | ||
|
||
- Start the documentation. | ||
```Bash | ||
mkdocs serve | ||
``` |