-
Notifications
You must be signed in to change notification settings - Fork 64
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
Somehow sync repo README and doc index.md? #73
Comments
Hey, thanks for mentioning it. If I didn't misunderstood, actually that functionality is already implemented. For example: https://github.com/typelevel/cats/blob/master/build.sbt#L138 You could ignore the index.md file that is automatically copied to the docs folder (since it'll be copied each time you call https://github.com/typelevel/cats/blob/master/.gitignore#L22 |
Oh right, perfect. That's it! 👍 |
Well. Not quite. Because it has no front matter it doesn't get included in the site. I'll think about it. No need to reopen. |
@tpolecat I just had the same issue and solved it, crudely, as follows:
It's perhaps not the cleanest solution, but at least I can get my readme content into the site without too much complication. |
Thanks @gpampara for sharing it! Do you think we could automate it somehow? |
I guess one could automate this. This would mean that the README would become the main page of the site though? Good? Bad? It works well for my use at the moment and I don't really see any glaring downsides, but I guess the option to override this behaviour would be reasonable. Suppose this would warrant another config option? Or it could be that if the user provides an |
An option to make the repo README become the landing page for the site sounds great to me. Until then I may use @gpampara's hack. Thanks Gary! |
Reopening because it seems like a thing. |
What do you think if we rewrite the extra md file configuration in the following way?
This configuration might generate the following files (in the docs folder):
Does it make sense? |
Yeah, that's a decent and reasonable approach. Keeps it consistent with the rest of the page definitions. |
The new scheme works well, thanks :) |
I'm finding that I want my repo's README and the index page for my microsite to be the same modulo front matter. This would be easy to hack up … would this be useful or am I just being weird?
The text was updated successfully, but these errors were encountered: