Skip to content

Commit 0cc7c80

Browse files
authored
add blog instructions (ProjectPythia#358)
1 parent e64b898 commit 0cc7c80

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ Guide](https://projectpythia.org/contributing.html) for overall
66
contribution guidelines (such as detailed description of Project
77
Pythia structure, forking, repository cloning, branching, etc.).
88

9+
## Instructions for adding a blog post
10+
11+
We use [Sphinx ABblog](https://ablog.readthedocs.io/en/stable/) to add blog posts to our site.
12+
13+
Within the `portal/posts/` folder add your `.md` blog file with the following heading:
14+
15+
```
16+
---
17+
blogpost: true
18+
date: MON DD, YYYY
19+
author: First Last
20+
tags: sample-tag
21+
---
22+
```
23+
24+
The post will automatically be recognized and displayed when you build the portal site.
25+
926
## Instructions for building the portal site
1027

1128
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:
6683

6784
```bash
6885
open _build/html/index.html
69-
```
86+
`````
7087

7188
However, many of the links will not work. For all of the links
7289
found in the portal to work properly, you'll need to set up a local

0 commit comments

Comments
 (0)