privacyguides/privacyguides.org
1
0
Fork 0
mirror of https://github.com/privacyguides/privacyguides.org.git synced 2025-07-01 17:22:39 +00:00
Code Issues Activity

Transition to mkdocs (#829)

Browse Source 
Co-authored-by: Jonah Aragon <jonah@triplebit.net>
This commit is contained in:
Daniel Gray
2022-04-01 19:29:18 +00:00
parent 78b49b2f4e
commit 8ef8e2a263
742 changed files with 4489 additions and 6624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,6 @@
<div align="center">
<a href="https://privacyguides.org">
<img src="/assets/img/layout/privacy-guides-logo.svg" width="500px" alt="Privacy Guides" />
<img src="/docs/assets/img/layout/privacy-guides-logo.svg" width="500px" alt="Privacy Guides" />
</a>
<p><em>Your central privacy and security resource to protect yourself online.</em></p>
@ -44,17 +44,7 @@
## Developing
1. Install the version of [Ruby](https://www.ruby-lang.org/en/downloads/) currently specified by [`.ruby-version`](.ruby-version)
* With [rbenv](https://github.com/rbenv/rbenv) (**recommended!**): `rbenv install`
* With [RVM](https://rvm.io): `rvm install "ruby-$(cat .ruby-version)"`
* [Manually](https://www.ruby-lang.org/en/downloads/)
1. Install node.js and npm
1. Install [Bundler](https://bundler.io/) v2.2.5:
* `gem install bundler:2.2.5`
1. Install the required dependencies:
* `bundle install`
* `npm install`
1. Build the website (the output can be found in the `_site` directory):
* `npm run build`
1. Serve the website locally with live reloading:
* `npm run serve`
1. [Install mkdocs](https://www.mkdocs.org/user-guide/installation/): `pip install mkdocs`
2. [Install mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/): `pip install mkdocs-material`
3. Serve the site locally: `mkdocs serve`
- The site will be available at `http://localhost:8000/`.