mirror of
https://github.com/c3lang/c3-web.git
synced 2026-05-31 02:29:08 -05:00
The website for C3 made with Astro!
https://c3-lang.org/
- Python 55.9%
- HTML 44.1%
| .github/workflows | ||
| docs | ||
| hooks | ||
| theme | ||
| .gitignore | ||
| LICENSE | ||
| mkdocs.yml | ||
| pyproject.toml | ||
| README.md | ||
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
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.5–2.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.htmlwith 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).