C3-Web

The C3 Website made with Astro, TailwindCSS and Starlight.

Get Started

1. Clone the repository with git clone https://github.com/c3lang/c3-web, move into the c3-web directory, and make sure you have Node.js installed.
2. Enable pnpm with corepack enable pnpm.
3. Install the website's dependencies with pnpm i, then run pnpm run astro build to package the site for offline use.
4. To view the site in your web browser, run pnpx http-server dist and click the link (defaults to http://127.0.0.1:8080).

• Or, if you want to contribute to the site, run pnpm run astro dev and click the link (defaults to http://localhost:4321). Then create a pull request on Github with your changes.

Project Structure

📦c3
 ┣ 📂public
 ┣ 📂src
 ┃ ┣ 📂components
 ┃ ┣ 📂content
 ┃ ┃ ┣ 📂docs
 ┃ ┃ ┃ ┗ 📂guide
 ┃ ┃ ┗ 📜config.js
 ┃ ┣ 📂pages
 ┃ ┃ ┗ 📜index.astro
 ┃ ┗ 📜env.d.ts
 ┣ 📜.gitignore
 ┣ 📜astro.config.mjs
 ┣ 📜package.json
 ┣ 📜tailwind.config.cjs
 ┗ 📜tsconfig.json

Contribution

If you want to contribute to this project, you can do so by forking this repository and creating a pull request.

Adding Documentation content

Navigate to one of the following folders: src/content/docs/guide or src/content/docs/references

create a file ending in .mdx (or .md) (or edit one that already exists)

and lastly add a little bit of a header on top of whatever markdown content you have, one that looks like this (for SEO and visibility on the website)

---
title: the C3 Handbook
description: A guide to the C3 Programming Language
---
and after the `---` everything else is just plain old markdown!

Please visit the Starlight Docs for more info.