diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 267d1ecf..4398fc02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,23 @@ Guide](https://projectpythia.org/contributing.html) for overall contribution guidelines (such as detailed description of Project Pythia structure, forking, repository cloning, branching, etc.). +## Instructions for adding a blog post + +We use [Sphinx ABblog](https://ablog.readthedocs.io/en/stable/) to add blog posts to our site. + +Within the `portal/posts/` folder add your `.md` blog file with the following heading: + +``` +--- +blogpost: true +date: MON DD, YYYY +author: First Last +tags: sample-tag +--- +``` + +The post will automatically be recognized and displayed when you build the portal site. + ## Instructions for building the portal site The portal site is built with [Sphinx](https://www.sphinx-doc.org/). @@ -66,7 +83,7 @@ Open with your web browser, or from the terminal: ```bash open _build/html/index.html -``` +````` However, many of the links will not work. For all of the links found in the portal to work properly, you'll need to set up a local