The website for C3 made with Astro! https://c3-lang.org/
  • Python 67.6%
  • HTML 32.4%
Find a file
2026-09-23 13:46:00 +02:00
.github/workflows Use setup-c3 action in stdlib docs workflow 2026-09-14 16:08:22 -03:00
docs Rename function attribute: @extern -> @cname 2026-09-23 13:46:00 +02:00
hooks Update latest. 2026-09-15 16:20:55 +02:00
theme Add merch link 2026-09-20 23:03:52 +02:00
.gitignore New site (#224) 2026-05-05 23:04:20 +02:00
LICENSE New site (#224) 2026-05-05 23:04:20 +02:00
mkdocs.yml blog: bring back authors metadata 2026-08-06 20:53:43 -03:00
pyproject.toml Blog feed with RSS (#262) 2026-07-31 19:17:35 -03:00
README.md Change logo source in README 2026-05-06 22:25:10 +02:00

C3 Documentation Site (MkDocs)

This documentation site for the C3 Programming Language is built using MkDocs and the Material theme.

[Go to the website]

Editing

Modify the files in the docs/ folder.

Search is provided by the Material for MkDocs search plugin.

You can tune search relevance per page via frontmatter:

---
# Rank this page higher in results (use low values, e.g. 1.52.0)
search:
  boost: 2

# Or remove a page from the index entirely
search:
  exclude: true
---

To exclude a specific section, add { data-search-exclude } after the heading (requires attr_list, which is already enabled):

## This section is indexed

## This section is not { data-search-exclude }

Setup

1. Using uv

uv run mkdocs serve

2. Manual Setup (pip)

If you prefer using standard pip:

# Create and activate a virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies from pyproject.toml
pip install .

# Run server
mkdocs serve

3. Build for Deployment

To generate the static HTML files:

uv run mkdocs build
# or
mkdocs build

The output will be in the site/ folder.

  • Local access: Open site/index.html with Firefox.
  • Server deployment: The site is automatically deployed via GitHub Actions to GitHub Pages.

Project Structure

  • docs/: Markdown source files.
  • docs/assets/css/extra.css: Landing page styles and MkDocs Material overrides.
  • theme/: Material theme overrides (templates and partials).
  • hooks/: MkDocs hook scripts (c3_lexer.py, latest_version.py).
  • mkdocs.yml: Configuration file.
  • pyproject.toml: Project configuration and dependencies.
  • site/: Generated static files (created after build).