https://github.com/c3lang/c3-web

The website for C3 made with Astro!
https://github.com/c3lang/c3-web

astro c3

Last synced: about 14 hours ago
JSON representation

The website for C3 made with Astro!

• Host: GitHub
• URL: https://github.com/c3lang/c3-web
• Owner: c3lang
• License: mit
• Created: 2024-01-07T14:40:27.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-20T15:10:42.000Z (10 days ago)
• Last Synced: 2025-01-23T09:07:03.190Z (8 days ago)
• Topics: astro, c3
• Language: Astro
• Homepage: https://c3-lang.org/
• Size: 771 KB
• Stars: 58
• Watchers: 7
• Forks: 35
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


C3-Web


The C3 Website made with [Astro](https://astro.build/), [TailwindCSS](https://tailwindcss.com/), [Preline](https://preline.co/) and [Starlight](https://starlight.astro.build/).

Get Started


After cloning the repository with `git clone`, you can run `npm run dev` and that's it!

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)

```astro

---

title: the C3 Handbook

description: A guide to the C3 Programming Language

---

aand after the `---` everything else is just plain old markdown!

```

Please visit the [Starlight Docs](https://starlight.astro.build/) for more info.