ractivejs / ractivejs.github.io

https://ractive.js.org
8 stars 33 forks source link

"Edit on GitHub" #42

Closed dagnelies closed 7 years ago

dagnelies commented 7 years ago

What I'm kind of missing from the old docs is the "edit this page" link on top. This was very handy and makes it easier for people to make a change. I tried to see if it can be done with mkdocs, but it only worked with the "readthedocs" theme, not with cinder nor mkdocs.

fskreuz commented 7 years ago

Taking this into consideration in theme changes.

The problem with the current theme is that mkdocs expects the docs to be in the same repo as the project (as the docs of the project). Both the "Edit this page" link and the Github repo link uses the same repo_url setting. It's currently set to the lib repo url.

mkdocs, like gitbook, is a good first step in integrating docs with lib so we can enforce updating docs when the code changes in the same repo. Just not right now.

evs-chris commented 7 years ago

There's now an edit link nestled between previous and next links at the bottom of every md page.

dagnelies commented 7 years ago

👍 👍 👍