Switch from GitBook to just-the-docs theme#8734
Merged
Merged
Conversation
- rename README.md to index.md - add YAML front matters - cleanup duplicates at OO documenation - minor text fixes
Member
|
Then don't forget to remove the gitbook integration |
Siedlerchr
added a commit
that referenced
this pull request
May 2, 2022
…om.github.tomtung-latex2unicode_2.12-0.3.0 * upstream/main: (59 commits) Bump postgresql from 42.3.3 to 42.3.4 (#8749) Bump org.openjfx.javafxplugin from 0.0.12 to 0.0.13 (#8748) Squashed 'buildres/csl/csl-locales/' changes from d834200f65..969d9567ac Squashed 'buildres/csl/csl-styles/' changes from 76b4268..25512a5 Fix typo Restructure page intro Delete head_custom.html "master" -> "main" Change code highlighting theme Update devdoc theme Fixed faulty devdoc adr link Updated devdocs links Switch from GitBook to just-the-docs theme (#8734) Fix link to maintainers (#8731) New Crowdin updates (#8725) Update snapcraft URL Update bug_report.yml for v5.6 Show development information\n\n+semver: minor Release v5.6 Finish external ...
Jonathan-Oliveira
pushed a commit
to Jonathan-Oliveira/jabref
that referenced
this pull request
May 7, 2022
- rename README.md to index.md - add YAML front matters - cleanup duplicates at OO documentation - minor text fixes - Fix image file names
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.mddescribed in a way that is understandable for the average user (if applicable)