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
is generated from source files in the
cuelang.org/go
module.
The site is deployed and hosted via Netlify.
To raise an issue about a specific page or piece of content, scroll to the bottom of the published page and use the "Report an Issue" link in the site footer. This link will save you time by prepopulating the issue with information that you'll need to find and fill in if you raise the issue manually.
To raise an issue manually, please open it in the
main CUE issue tracker,
giving the issue's title a "cuelang.org:
" prefix.
- NodeJS
v20.x
- Go
>= go1.21
(not needed for only runninghugo
) - Hugo
>= v0.124.0
("extended" binary version) - Docker CLI
>= 19.03
(fordocker buildx
use, amongst other things)- Podman has been used successfully, instead of Docker, but its use is currently undocumented
This contains the unprocessed content for the website
This contains the app code for the cue-playground
This contains cloud functions
This contains all code to build the hugo-website.
Internal stuff: can be ignored
Can be ignored
To serve the site locally run:
./_scripts/build.bash # one-off to ensure everything works
./_scripts/serve.bash [--update] # update flag writes changes back into source files under content/
The site will be served at http://localhost:1313/.
The site's CUE content is formatted, tested, and used to produce output by the
latest
version of CUE stored in site.cue
.
See commit https://github.com/cue-lang/cuelang.org/commit/80c17ba707e239adfe7794ffcfc79f314ed51841 (and the commit that comes after, updating cache files) for an example of how to update this version.
The spec is handled by a different version of CUE, as tracked in cue-lang/cue#3013.
It is generated against the required version of the cuelang.org/go
module:
go generate ./...
To update the generated spec you need to update the site's required version of cuelang.org/go
:
go get cuelang.org/go@latest
tip.cuelang.org currently redirects to cuelang.org, but it is intended that this site should:
- have the same template and content as
cuelang.org, except that all pages will have their
data formatted and output emitted by
cuelang.org/go@master
; - be redeployed when any commit is added to to
master
oncue-lang/cuelang.org
orcue-lang/cue
.
This is not currently implemented, and is tracked in https://cuelang.org/issues/2538.
This site was setup using the following guides: