privsec.dev/README.md
2023-01-15 05:00:43 -05:00

2.4 KiB
Raw Blame History

PrivSec.dev

~A practical approach to Privacy and Security~

Netlify Status

Licensing

Prospective contributors are encouraged to review CONTRIBUTING.md, including the Contributor License Agreement.

Posts are licensed under the Creative Commons AttributionShareAlike 4.0 International License. Please make sure to attribute the author(s) properly and include a link to the original publication when applicable.

Hugo, the static site generator used to build the site, is licensed under the Apache License 2.0.

The WonderMod theme (and its upstream PaperMod) is licensed under the MIT License. Except where otherwise noted, PrivSec.dev's modifications to WonderMod are also licensed under the MIT License.

Hosting (Netlify)

The https://privsec.dev website is hosted by Netlify. Netlify will automatically generate previews for pull requests and on pull request updates.

Local Working Environment

  1. Install Git and Hugo.
  2. Clone this repository: git clone --recurse-submodules https://github.com/PrivSec-dev/privsec.dev.
  3. Run hugo serve to start the local development server at (by default) http://localhost:1313.
    • Alternatively run hugo to simply build the site into the public/ directory.
  • Run git submodule update --merge to update the WonderMod theme to the version specified in this repo.
    • Run git submodule update --remote --merge to update to the upstream master branch of WonderMod.
  • Run ./external-blogs.sh to pull the latest versions of certain posts from their canonical (external) sources.