-
Notifications
You must be signed in to change notification settings - Fork 29
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
Generate website from README. #42
Comments
i'd be curious to see a MVP of a better solution here.. |
I'll whip up a quick MVP today. |
Alright, figured out all the kinks, CI integration, etc. Let me know if you want me to make a PR. |
mind posting the link again? what do you need me to do to enable you to hook it up to FEMBusinessModelsRing.github.io ? |
Here is the link to the WIKI. I'll do some final cleanup tonight and make sure everything works (images, metadata, etc.). I think the only thing that would need to be done is a merge script run by something like Travis. So, when a contributor makes a PR and submits, Travis automatically recompiles the wiki and deploys to Github pages. So the needs would be:
Other than that, let me see if there is a way to deploy the github pages without Travis. I doubt there is, but I'd like to make sure (since this should be as simple as possible). |
@Anish-Agnihotri i just invited you to this organization. when u join u should have all the permissions needed to set this up |
Sweet, sounds good. I’ll set it up and get it running in the morning tomorrow. |
As the
README.md
grows, it's important to keep it organized, and the information easily accessible for the average reader. In addition, with the addition of more complex topic (think:Continuous organizations
), having the option to present information in larger summaries would be beneficial.This issue aims to highlight a potential way that this issue could be alleviated: through the creation of a website that simply compiles the information from the
README.md
into an easily readable wiki-format (think similar to what EthHub has done).Requirements:
README.md
is cleaned up and put into proper order.README.md
is potentially broken up into separate paginated parts.README.md
automatically generate a website hosted with Github Pages.Definition of done
README.md
, with an easy way to add information by simply editing the source markdown files.The text was updated successfully, but these errors were encountered: