/user-documentation

User documentation of JabRef

Creative Commons Attribution 4.0 InternationalCC-BY-4.0

JabRef User Documentation

This repository serves the content of https://docs.jabref.org/ and https://help.jabref.org/.

Feel free to improve the page using the issue tracker or by following our guide.

How to regenerate SUMMARY.md from scratch

Use https://github.com/koppor/gitbook-summary-generator.

How to find broken links

  1. Install markdown-link-check: npm install -g markdown-link check
  2. find . -name \*.md -exec markdown-link-check -qq {} \; > bad-links.txt

How to find Markdown errors

You can use the markdown-lint docker image:

docker run --rm \
    -v "$(pwd):/tmp/check" \
    -e INPUT_CONFIG=/tmp/check/.markdownlint.yml \
    avtodev/markdown-lint:v1 \
    /tmp/check/en