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 pydata-sphinx-theme blog example #349

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jarrodmillman
Copy link
Member

No description provided.

@jarrodmillman jarrodmillman added the type: Documentation Improvements or additions to documentation label Nov 1, 2023
Copy link

netlify bot commented Nov 1, 2023

Deploy Preview for scientific-python-hugo-theme failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit 1720bd9
🔍 Latest deploy log https://app.netlify.com/sites/scientific-python-hugo-theme/deploys/65e746316b7bb50008b78a8b

@jarrodmillman jarrodmillman marked this pull request as draft November 1, 2023 04:48
@stefanv
Copy link
Member

stefanv commented Nov 1, 2023

Need to:

  1. Add layout or type metadata to blog post that is outside of either /posts or /blog.
  2. Use correct metadata fields (ours are a bit different from theirs, in that we use authors, tags is a list, and we only use tags (no categories).
  3. Document how to add /blog / /posts (easy, just put posts in there, as well as _index.md files for each subdirectory---see blog.scientific-python.org as an example), or elsewhere (harder, need to use the layout or type metadata).

@stefanv
Copy link
Member

stefanv commented Nov 1, 2023

type: posts

seems to do the trick, both for _index.md files and blog post entries.

@stefanv
Copy link
Member

stefanv commented Nov 1, 2023

Also document that:

disableKinds: ["term", "taxonomy"]

In config.yaml would prevent tags from rendering; ensure term is not in there.

@@ -0,0 +1,4 @@
---
title: Blog
type: posts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to allow post here as well, just so this reads more naturally. Currently, it's basically "the type of this page is the same as if it were in the posts category", but would be more logical to say "the type of this page is a post".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants