jpluscplusm-forks / cue-lang.cuelang.org Goto Github PK

This repo is the home of cuelang.org. The site is built using Hugo and is based on the docsy theme.

The CUE Language Specification and tour are generated from source files in the cuelang.org/go module; the results are currently not committed to this repository.

The site is deployed and hosted via Netlify.

Please raise all issues in the main CUE repository, giving the title of the issue a cuelang.org: prefix.

• NodeJS == v14.17.3
• Go == go1.17.3
• Hugo == v0.89.4

# Ensure you have the correct version of the docsy theme
git submodule update -f --init --recursive

# Install Hugo's Node requirements
npm install

To serve the site locally run:

./serve.bash        # In one terminal
./play/run.bash     # In another terminal

The tour and spec and generated against the required version of the cuelang.org/go module:

go generate ./...

Therefore to update the generated version you need to update the required version of cuelang.org/go:

go get cuelang.org/[email protected]

tip.cuelang.org has the exact same site template and content as cuelang.org except for the fact the language spec and tour are generated based on cuelang.org/go@master. Any commit to master of this repository or github.com/cue-lang/cue will result in a redeploy of tip.cuelang.org.

This site was setup using the following guides:

• https://gohugo.io/hosting-and-deployment/hosting-on-netlify/
• https://www.docsy.dev/docs/getting-started
• https://www.docsy.dev/docs/deployment/