https://github.com/nathaneastwood/fablore
A Flesh and Blood Lore Book Website
https://github.com/nathaneastwood/fablore
flesh-and-blood-tcg mdbook
Last synced: about 1 month ago
JSON representation
A Flesh and Blood Lore Book Website
- Host: GitHub
- URL: https://github.com/nathaneastwood/fablore
- Owner: nathaneastwood
- License: mit
- Created: 2022-10-10T21:04:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-06T19:50:09.000Z (3 months ago)
- Last Synced: 2025-08-06T21:33:41.595Z (3 months ago)
- Topics: flesh-and-blood-tcg, mdbook
- Language: Handlebars
- Homepage: https://legendarystories.net
- Size: 5.32 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fablore
[](https://github.com/nathaneastwood/fablore/actions)
[](./LICENSE)
[](https://legendarystories.net)
[](https://www.buymeacoffee.com/nathaneastwood)
**fablore** is the source repository for [Legendary Stories](https://legendarystories.net/), a community-curated digital archive of all known official *Flesh and Blood* lore. The site is built using [mdBook](https://github.com/rust-lang/mdBook).
## 🚀 Getting Started
### Prerequisites
* Install [mdBook](https://github.com/rust-lang/mdBook)
* Clone the repository:
```bash
git clone https://github.com/nathaneastwood/fablore.git
cd fablore
```
### Build the Book
```bash
mdbook build
```
### Serve Locally
```bash
mdbook serve --open
```
## 🖼️ Images
Images should be optimised and converted to [WebP](https://chromium.googlesource.com/webm/libwebp) format before use.
Convert a directory of images like so:
```bash
for file in path/to/files/*; do cwebp "$file" -o "${file%.*}.webp"; done
```
Install `cwebp` using your system package manager, or refer to the [official installation guide](https://developers.google.com/speed/webp/download).
## 🧩 Extensions
This project makes use of several mdBook extensions:
### `mdbook-hints`
Enable tooltips by adding the following to your `index.hbs`:
```html
```
### `mdbook-pagetoc`
Enable per-page table of contents by modifying:
```hbs
{{{ content }}}
```
to:
```hbs
{{{ content }}}
```
Ensure you're using a custom theme and have copied the latest [`index.hbs`](https://github.com/rust-lang/mdBook/blob/master/src/theme/index.hbs) as a starting point.
## 🔍 Link Checking with `html-proofer`
To ensure all internal and external links in the built site are valid, run [`html-proofer`](https://github.com/gjtorikian/html-proofer):
```bash
gem install html-proofer
htmlproofer book/ --check-html --allow-hash-href
```
This will scan the `book/` output directory after building to catch broken links, missing anchors, and malformed HTML.
## 📏 Linking Rules
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`](#mdbook-hints).
## 📜 License
Code in this repository is licensed under the **MIT License**. All lore content is © Legend Story Studios. See [LICENSE](./LICENSE) for details.