diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..7d7c3b016 --- /dev/null +++ b/docs/README.md @@ -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. \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index 9762765bb..dd1a09797 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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