Files
carbon-lang/website
Jon Ross-Perkins 977578add1 Update icons for slightly better sizing (#5013)
Changes utils/vscode/images/icon.png to 256x256 (["The path to the icon
of at least 128x128 pixels (256x256 for Retina
screens)."](https://code.visualstudio.com/api/references/extension-manifest#fields)),
and updates the favicon.png to use the same source image.

For reference, changing this to:

https://docs.google.com/drawings/d/16V_E_LS7zqZu6VkNdZgIMqSwc96eV_fw98nIYoY1bBg/edit

The image changes slightly because I don't recall my prior source (and
it didn't seem important to precisely match font size), but hopefully
the drawing helps.
2025-02-27 00:00:55 +00:00
..
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00
2024-08-20 17:53:06 +00:00

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:

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).