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

Different GitHub README than site home page #19

Closed
niconoe opened this issue Jun 29, 2021 · 4 comments
Closed

Different GitHub README than site home page #19

niconoe opened this issue Jun 29, 2021 · 4 comments

Comments

@niconoe
Copy link
Collaborator

niconoe commented Jun 29, 2021

Currently, the same README.md is used as a source for two different web pages. It would be great if:

@peterdesmet
Copy link
Member

I think it's fine if the two are the same? If you don't want this, we can add an index.md, but then we have to maintain two files.

@niconoe
Copy link
Collaborator Author

niconoe commented Jun 30, 2021

Yeah, I'd prefer to have two files despite the small maintenance overhear, because I think it's not immediately obvious when you end up on the GitHub page that if you just want to read about the format, you should go to the website rather than trying to extract the info from the raw files in the repository.

So if I understood correctly, I can just add an index.md file and it will be picked up by Jekyll for the home page instead of README.md?

@peterdesmet
Copy link
Member

I think so. You can the also remove the frontmatter from README (and put it in index.md)

@niconoe
Copy link
Collaborator Author

niconoe commented Aug 5, 2021

Done!

@niconoe niconoe closed this as completed Aug 5, 2021
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

No branches or pull requests

2 participants