Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add blog instructions #358

Merged
merged 1 commit into from
Sep 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down Expand Up @@ -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
Expand Down
Loading