Skip to content

use index.md for subdirectory pages #84

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

Merged
merged 1 commit into from
May 17, 2023

Conversation

joshmoore
Copy link
Member

@MSanKeys963 this is what I meant with #78 (comment)

@sanketverma1704
Copy link
Member

Thanks for the PR, @joshmoore.

From your comment - Do you only want to rename the sub-directory pages to index.md, or are you proposing to change the front matter as well?

@joshmoore
Copy link
Member Author

hmm... odd. Sorry, there should have been this diff:

@@ -2,7 +2,6 @@
 layout: single
 author_profile: false
 title: Zarr Community
-permalink: /community/
 sidebar:
   title: "Content"
   nav: sidebar

What did you try?

@sanketverma1704
Copy link
Member

This is the same front matter currently in community.md.

I thought you wanted me to remove layout: single and author_profile: false from the front matter, which won't work as layout: single is needed to display the sidebar according to minimal mistakes theme configuration.

Am I missing something?

@joshmoore
Copy link
Member Author

That diff suggests only removing the line permalink: /community/. i.e., if the main page in subdirectories is "index.md" then you don't need to add the permalink. i.e.:

/community/ --> /community/index.html

automatically. And I think doing that by default makes things easier to understand for people working in the repository.

@sanketverma1704
Copy link
Member

Thanks for the explanation, @joshmoore.

LGTM. I'll merge this now; after this, we can follow the same rule for other subpages.

@sanketverma1704 sanketverma1704 merged commit 5135ff3 into zarr-developers:main May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants