mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 19:50:14 +01:00
Jon Ross-PerkinsandChandler Carruth
b6396e97f8
Demo site: https://jonmeow.carbon-lang.dev/ I'm trying to keep work under the `/website` subdirectory so that the misc files don't interfere with unrelated views of the repository. The `prebuild.py` script does some work to move things around and add frontmatter, helping the jekyll generation. I'm using the "just-the-docs" theme because I think it's a decent match for what we want, and getting jekyll up and running with it wasn't too difficult. Note #1526 proposed using Docusaurus; I started out there, but was having trouble getting it working with newer versions. The plugins in particular I got stuck trying to make work, which sent me looking for options that we could have working with less customization. I do lean towards jekyll though, because it's what GH uses so hopefully we can get a more consistent experience. Having a website has been approved for a while under #1492, but hasn't been a priority. I'm mainly doing this because I want to just be able to point people to carbon-lang.dev and have easy links that way. --------- Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
26 lines
751 B
YAML
26 lines
751 B
YAML
# Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
# Exceptions. See /LICENSE for license information.
|
|
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
title: Carbon Language documentation
|
|
description: An experimental successor to C++
|
|
|
|
# https://just-the-docs.github.io/just-the-docs/
|
|
theme: just-the-docs
|
|
|
|
favicon_ico: '/favicon.png'
|
|
|
|
aux_links:
|
|
Discord: https://discord.gg/ZjVdShJDAs
|
|
GitHub: https://github.com/carbon-language/carbon-lang
|
|
|
|
mermaid:
|
|
# Version of mermaid library
|
|
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
|
|
version: '10.9.1'
|
|
|
|
# We add frontmatter to files, but still want README.md -> index.md.
|
|
readme_index:
|
|
remove_originals: true
|
|
with_frontmatter: true
|