https://github.com/inlets/docs.inlets.dev
Inlets documentation
https://github.com/inlets/docs.inlets.dev
Last synced: over 1 year ago
JSON representation
Inlets documentation
- Host: GitHub
- URL: https://github.com/inlets/docs.inlets.dev
- Owner: inlets
- License: mit
- Created: 2021-11-12T10:02:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T20:03:54.000Z (almost 2 years ago)
- Last Synced: 2024-09-15T10:55:40.050Z (almost 2 years ago)
- Size: 1.69 MB
- Stars: 8
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Inlets documentation
=====================
## Development
### Run locally
Pre-reqs
You'll need Python and pip installed, then run:
```bash
pip install -r requirements.txt
```
Local testing:
```bash
mkdocs serve
```
### Run with docker
Run in docker container
```sh
docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material:latest
```
Access the site at http://127.0.0.1:8000
## Contributing
See the [inlets contribution guide](https://github.com/inlets/inlets-pro/blob/master/CONTRIBUTING.md)
All commits must be signed-off with the CLI using `git commit --sign-off`