Skip to content

Repository for the Alice Thornton Digital Edition project

Notifications You must be signed in to change notification settings

kingsdigitallab/alice-thornton

Repository files navigation

Alice Thornton project code

Build Site TEI Validation

Open in Gitpod: design branch | develop branch

The web site is developed using a Static Site Generator called 11ty.

Site deployment

  • The live/public site is generated from the main branch every 30 minutes. Researchers can edit the markdown content of the site directly on this branch.
  • The staging site is generated from the release branch every 30 minutes. This branch and site are used by the KDL team to test and demonstrate new features and fixes before publishing them to main branch.
  • The development site is generated from the develop branch every 30 minutes. This branch and site are used by the KDL team to experiment with new, unstable features.

Edition

  • The TEI editions of the books are kept in the edition branch
  • The HTML chunks are generated from the TEI editions every day at 1pm & 6pm and saved into the dts branch (Use github action or npm run tei2html to run it manually.)
  • The staging (and development) Text Viewer reads HTML chunks from the dts branch
  • The live Text Viewer reads HTML chunks from the dts-liv branch. Which is a snapshot done manually from the dts branch before a live/public release.

Developing the DTS server

To edit the code of the DTS server locally while testing it with the AT Text Viewer on the AT edition:

  1. git clone kdl-dts-server in a new folder outside the project
  2. Start the server: npm run start:at (will run on localhost:3000)

Server build for each type (dev|stg|liv) of site:

export SITE_ENV='dev'; npm run rebuild