Skip to content

TeachBooks/external-content

Repository files navigation

Teachbook recombiner

This is a web app to pick chapters from a pre-defined list of teach books and combine them into a new book using the new external table of content entry type, see teachbook package.

Checked with Biome

Develop

# Install dependencies
pnpm install
# Start the development server
pnpm dev
# Run formatter and linter in fix mode
pnpm format
# Run linter
pnpm lint
# Run type checker
pnpm typecheck
# Build the app
pnpm build
# Preview the built app
pnpm preview

Catalog

In catalog.yml you can find the list of books and chapters that can be combined.

In catalog.json you can find the same books, but with their table of contents fetched. You should not edit this file manually, as it is generated by the harvest.py script.

The catalog.json file is generated by running the following command:

# Install the dependencies, if you haven't already
pip install -e .
./harvest.py
# The catalog.json file will be generated