Skip to content
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

Switch from GitBook to just-the-docs theme #8734

Merged
merged 2 commits into from
Apr 29, 2022
Merged

Conversation

koppor
Copy link
Member

@koppor koppor commented Apr 28, 2022

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)

grafik

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

grafik

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

koppor added 2 commits April 29, 2022 00:53
- rename README.md to index.md
- add YAML front matters
- cleanup duplicates at OO documenation
- minor text fixes
@Siedlerchr
Copy link
Member

Then don't forget to remove the gitbook integration

@koppor koppor merged commit 955badf into main Apr 29, 2022
@koppor koppor deleted the switch-to-just-the-docs branch April 29, 2022 17:11
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants