mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
27 lines
793 B
Markdown
27 lines
793 B
Markdown
<!-- markdownlint-disable MD002 -->
|
|
# Firezone Docs
|
|
<!-- markdownlint-enable MD002 -->
|
|
|
|
## To run the local docs server
|
|
|
|
1. Make sure you're in this directory: `cd docs/`
|
|
2. `bundle install`
|
|
3. `bundle exec jekyll serve`
|
|
|
|
## Overview
|
|
|
|
This repository is for our documentation website found at
|
|
[https://docs.firezone.dev](https://docs.firezone.dev).
|
|
|
|
## Contributing
|
|
|
|
We uses pages to organize our documentation. Please see the
|
|
[Jekyll site](https://jekyllrb.com/docs/pages/) for more information.
|
|
|
|
### Setup
|
|
|
|
We are using [Jekyll](https://jekyllrb.com/docs/) to generate the site and
|
|
[Github Pages](https://pages.github.com/) to host it. When developing locally,
|
|
you can use the [`jekyll serve`](https://jekyllrb.com/docs/serving-jekyll/)
|
|
command to start a server from the `/docs` directory.
|