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

Use index.md for subfolder parents in documentation to get nicer links #161

Closed
m3nu opened this issue Jul 23, 2019 · 2 comments
Closed

Use index.md for subfolder parents in documentation to get nicer links #161

m3nu opened this issue Jul 23, 2019 · 2 comments

Comments

@m3nu
Copy link
Contributor

m3nu commented Jul 23, 2019

Is your feature request related to a problem? Please describe.
Current documentation recommends putting children in a common folder and naming the parent residing in the same folder e.g. utilities/utilities.md.

This results in fairly weird permalinks, e.g. example.com/utilities/utilities.

Describe the solution you'd like
I tried using index.md for the parent page in a sub folder and it works as well AND gives nice links. E.g. example.com/utilities. To use the example it would look like this:

|   |-- utilities
|   |   |-- index.md      (parent page, now available under /utilities or /utilities/index.html)
|   |   |-- color.md
|   |   |-- layout.md
|   |   |-- responsive-modifiers.md
|   |   +-- typography.md

If there are no technical reasons against naming the parent page index.md, I would go ahead and make a PR for this to update the documentation. It seems no code changes are needed as it already works when used.

@m3nu m3nu changed the title Documentation regarding "pages with children" Use index.md for subfolder parents in documentation to get nicer links Jul 23, 2019
@pmarsceill
Copy link
Collaborator

Sure, go for it 👍

@m3nu
Copy link
Contributor Author

m3nu commented Aug 15, 2019

Great. Added a suggested PR that updates the documentation at #181.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants