fablore is the source repository for Legendary Stories, a community-curated digital archive of all known official Flesh and Blood lore. The site is built using mdBook.
- Install mdBook
- Clone the repository:
git clone https://github.com/nathaneastwood/fablore.git
cd fabloremdbook buildmdbook serve --openImages should be optimised and converted to WebP format before use.
Convert a directory of images like so:
for file in path/to/files/*; do cwebp "$file" -o "${file%.*}.webp"; doneInstall cwebp using your system package manager, or refer to the official installation guide.
This project makes use of several mdBook extensions:
Enable tooltips by adding the following to your index.hbs:
<!-- Required by mdbook-hints -->
<script src="https://unpkg.com/@popperjs/core@2"></script>
<script src="https://unpkg.com/tippy.js@6"></script>Enable per-page table of contents by modifying:
to:
Ensure you're using a custom theme and have copied the latest index.hbs as a starting point.
To ensure all internal and external links in the built site are valid, run html-proofer:
gem install html-proofer
htmlproofer book/ --check-html --allow-hash-hrefThis will scan the book/ output directory after building to catch broken links, missing anchors, and malformed HTML.
Heroes and documented places will have links to their respective pages. Characters, animals, plants, food, drink, etc. will have a hover over tooltip generated using mdbook-hints.
Code in this repository is licensed under the MIT License. All lore content is © Legend Story Studios. See LICENSE for details.