Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.33 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.33 KB

stlab Documentation

This site is available at stlab.cc.

Pull requests for typos, examples, and other improvements are welcome. To file an issue, please use the libraries repository.

Building the Documentation

To run a local Jekyll server, see the instructions in the docker-tools README.

Running Hyde in Docker

Configure the build as follows:

cmake --preset=hyde-build-docs

Login to GitHub Packages registry

echo $CR_PAT | docker login ghcr.io --password-stdin -u USERNAME

Fetch the latest image and run it:

HYDE_VERSION=2.0.1
docker pull ghcr.io/adobe/hyde:$HYDE_VERSION

docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host \
    --tty --interactive \
    ghcr.io/adobe/hyde:$HYDE_VERSION bash

From the docker prompt

cd /mnt/host/libraries/docs
./generate_docs.sh
./about.sh

[ this is from the old docs - need to update the docs and script.

(or, simply -u) to generate the boilerplate for it. Then, fill in any fields marked as __MISSING__. Fields marked as __OPTIONAL__ may be omitted. ]