mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
adding a simple readme and fixing the theme reference
@jamilbk actually you can just keep both lines uncommented to work for github pages and locally 😅
This commit is contained in:
13
docs/README.md
Normal file
13
docs/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Firezone Docs
|
||||
|
||||
## Overview
|
||||
|
||||
This repository is for our documentation website found at https://docs.firez.one/.
|
||||
|
||||
## 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.
|
||||
@@ -33,7 +33,7 @@ logo: "/assets/images/firezone-logo-wordmark-dark.svg"
|
||||
|
||||
# Build settings
|
||||
remote_theme: pmarsceill/just-the-docs
|
||||
# theme: just-the-docs # for local development
|
||||
theme: just-the-docs
|
||||
color_scheme: fz
|
||||
|
||||
# Footer content
|
||||
|
||||
Reference in New Issue
Block a user