User documentation of JabRef
This repository serves the content of https://docs.jabref.org/, which is the documentation the literature management software JabRef. :gear: The page itself is rendered using the power of GitBook.
SUMMARY.md
from scratchUse https://github.com/koppor/gitbook-summary-generator.
npm install -g markdown-link check
find . -name \*.md -exec markdown-link-check -qq {} \; > bad-links.txt
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
Alternatively, you can run the GitHub Lint workflow:
act --rm --platform ubuntu-latest=fwilhe2/act-runner:latest -W .github/workflows/lint.yaml
The gitbook integration changes some of the file names and appends "(1) (2) (1)" or something like this. If one fixes that in the GitHub repository, then the next sync rewrites the names again. The only solution we've found so far is manually replacing the images using the GitBook UI: Left to the image you have a hamburger with a "replace" option.
In case GitBook was fixed, with some command line magic, this could be solved:
fd -e png -x bash -c "echo '{}' | sed 's/\([^(]*\)\(.*\).png/mv \"\\1\\2.png\" \"\\1.png\"/' | sed 's/ \.png/.png/'" | sort > fix-filenames.sh
. Execute in en/.gitbook
. Otherwise, fd
does not find any file..md
files: fd -e md -x bash -c "echo sed -i '\"s/assets\/\([^%]*\)\(.*\).png/assets\/\\1.png/\"' {}" > fix-mds.sh
.