https://github.com/netboxlabs/console-docs
NetBox Cloud documentation
https://github.com/netboxlabs/console-docs
documentation netbox-cloud
Last synced: over 1 year ago
JSON representation
NetBox Cloud documentation
- Host: GitHub
- URL: https://github.com/netboxlabs/console-docs
- Owner: netboxlabs
- Created: 2022-12-01T16:15:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T13:40:53.000Z (over 1 year ago)
- Last Synced: 2025-03-19T14:35:35.906Z (over 1 year ago)
- Topics: documentation, netbox-cloud
- Language: HTML
- Homepage: https://docs.netboxlabs.com/
- Size: 40 MB
- Stars: 3
- Watchers: 10
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# console-docs
## Clone and step into the repo
```
# git clone https://github.com/netboxlabs/console-docs
# cd console-docs
```
## Install required python packages
```
# python3 -m venv venv
# source venv/bin/activate
(venv) # pip install -r requirements.txt
```
## Run mkdocs
```
(venv) # mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
- Administration Console/console-overview.md
- NetBox Cloud/getting-started-with-nbc.md
INFO - Documentation built in 0.75 seconds
INFO - [13:37:39] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [13:37:39] Serving on http://127.0.0.1:8000/
```
## :warning:
If you see errors like this...
> ERROR - Config value 'theme': Unrecognised theme name: 'material'. The available installed themes are: mkdocs, readthedocs
> ERROR - Config value 'markdown_extensions': Failed to load extension 'pymdownx.tabbed'.
> ModuleNotFoundError: No module named 'pymdownx'
Try uninstalling `mkdocs` from your package manager, (e.g. `brew uninstall mkdocs`) and just using the version installed by `pip`. It seems that `mkdocs` doesn't like it when you've installed it using different methods.