aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps
diff options
context:
space:
mode:
authorGravatar kosayoda <[email protected]>2021-03-26 14:34:49 +0800
committerGravatar kosayoda <[email protected]>2021-03-26 14:34:49 +0800
commiteb308e9ff697c1879f102522ece9bb97e77c5262 (patch)
tree21d8fa931489748c005c1e11609210691eb2652a /pydis_site/apps
parentRefactor content app tests. (diff)
Remove guide reference to `markdown2`.
Now that we use a separate library for frontmatter (which uses pyyaml), we can simplify the guide and remove the reference to the old markdown library.
Diffstat (limited to 'pydis_site/apps')
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md4
1 files changed, 1 insertions, 3 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md b/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md
index 12969ba2..f258ef74 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/how-to-contribute-a-page.md
@@ -37,7 +37,7 @@ All the markdown files in this folder will then be under this category.
Files representing pages are in `.md` (Markdown) format, with all-lowercase filenames and spaces replaced with `-` characters.
Each page must include required metadata, and optionally additional metadata to modify the appearance of the page.
-The metadata is written in YAML-like key-value pairs, and should be enclosed in triple dashes `---` *at the top of the markdown file*.
+The metadata is written in YAML, and should be enclosed in triple dashes `---` *at the top of the markdown file*.
**Example:**
```yaml
@@ -54,8 +54,6 @@ relevant_links:
Pages, which include guides, articles, and other static content,...
```
-You can learn more about Markdown metadata [here](https://github.com/trentm/python-markdown2/wiki/metadata).
-
### Required Fields
- **title:** Easily-readable title for your article.
- **description:** Short, 1-2 line description of the page's content.