Chandler CarruthandRichard Smith
cfd1ed8484
Rumdl already appears to have _significantly_ fewer bugs than prettier, and a solid LSP for editor integration. The tool is: https://github.com/rvben/rumdl/ I've separated out the change across three commits for easier review. The configuration tries to match the existing formatting, the changes to the all the files are to correct issues found by the new tool. Assisted-by: Antigravity with Gemini --------- Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Documentation website
Table of contents
Overview
Carbon's main website is the GitHub project page. Carbon remains too early and experimental to have a full-fledged website.
This directories contains infrastructure for building the convenience documentation website, which should be at https://docs.carbon-lang.dev.
Build process
Website generation is done by
gh_pages_deploy.yaml. It runs
prebuild.py, which prepares files for website generation, then builds the
website using Jekyll, configured through _config.yml.
Development tips
rbenv can be used to set up Ruby and bundle.
To run a server, run bundle exec jekyll serve. See
Jekyll docs for more commands.
To update the Gemfile.lock after Gemfile changes, run bundle update.
Domain configuration
The custom domain is configured in three places:
- GitHub organization verified domains
- GitHub repository custom domain
- Google Cloud DNS
- This is visible with
dig docs.carbon-lang.dev
- This is visible with
Note all of these require admin permissions to modify. For sharing test pages, a
GitHub user and repository can be used, pushing to <username>.github.io (or
getting a custom DNS setup).