Switch from GitBook to just-the-docs theme #8734
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Years ago, we switched from markdown file rendering to the GitBook service for https://devdocs.jabref.org (source: https://github.com/JabRef/jabref/tree/main/docs). There, we gained a) WYSIWG editors, b) instant search, c) insights on pages views, and d) user ratings. We "payed" with a) continuous renaming of images, b) difficulties in synchronization (stopped working after a few months) and c) sometimes strange markup.
Example for c) and d)
I found just-the-docs markdown theme. It offers a) instant search, b) site analytics (using google analytics) and is "just" a static web page.
IMHO we had no contributions using GitBook and only issues. Thus, I propose to switch back to plain Markdown.
Screenshot: left: GitBook, right: just-the-docs theme
CHANGELOG.md
described in a way that is understandable for the average user (if applicable)