Welcome to the official documentation site for the Arc programming language! This repository contains the source code for the Arc documentation website, built with Next.js.
This documentation site provides comprehensive guides, references, and examples for the Arc programming language, including:
- Getting Started: Installation, setup, and first steps
- Language Reference: Detailed documentation of Arc's syntax and features
- Standard Library: Documentation for Arc's built-in libraries
- Development Guide: Contributing to Arc and building from source
-
Clone this repository:
git clone https://github.com/Ranzeplay/arc cd arc/docs -
Install dependencies:
pnpm install
-
Start the development server:
pnpm dev
-
Open http://localhost:3000 in your browser
pnpm dev- Start the development server with Turbopackpnpm build- Build the application for productionpnpm start- Start the production serverpnpm postinstall- Process MDX files (runs automatically after install)
arc-docs/
├── app/ # Next.js app directory
│ ├── (home)/ # Home page route group
│ ├── docs/ # Documentation pages
│ ├── api/ # API routes (search)
│ ├── global.css # Global styles
│ ├── layout.tsx # Root layout
│ └── layout.config.tsx # Layout configuration
├── content/ # MDX documentation content
│ └── docs/ # Documentation files
│ ├── development/ # Development guides
│ ├── reference/ # Language reference
│ ├── stdlib/ # Standard library docs
│ └── usage/ # Usage examples
├── lib/ # Utility libraries
├── source.config.ts # Fumadocs configuration
├── next.config.mjs # Next.js configuration
└── package.json # Project dependencies
Documentation is written in MDX format and stored in the content/docs/ directory. Each MDX file should include frontmatter with at least a title:
---
title: Your Page Title
description: Optional description
---
# Your content here
This supports both Markdown and React components.- Create a new
.mdxfile in the appropriate directory undercontent/docs/ - Add the page to the relevant
meta.jsonfile for navigation - The page will automatically be included in the site navigation
The site supports LaTeX mathematical expressions using KaTeX:
Inline math: $E = mc^2$
Block math:
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$- Fast: Built with Next.js 15 and Turbopack for optimal performance
- Modern UI: Clean, responsive design powered by Fumadocs UI
- Math Support: LaTeX expressions rendered with KaTeX
- Search: Full-text search functionality
- Dark Mode: Automatic dark/light theme switching
- Mobile Friendly: Responsive design that works on all devices
- Framework: Next.js 15
- Documentation: Fumadocs
- Styling: Tailwind CSS
- Content: MDX
- Math: KaTeX
- Icons: Lucide React
- Package Manager: pnpm
We welcome contributions to improve the documentation! Here's how you can help:
- Fork this repository
- Create a new branch for your changes
- Make your improvements (fix typos, add examples, improve explanations)
- Test your changes locally with
pnpm dev - Submit a pull request
- Use clear, concise language
- Include practical examples
- Follow the existing documentation structure
- Test code examples to ensure they work
- Add appropriate frontmatter to new pages
This documentation is part of the Arc programming language project. Please refer to the main repository for licensing information.
If you have questions about Arc or find issues with the documentation:
- Issues: Open an issue in the main Arc repository
- Discussions: Join discussions in the Arc community
- Documentation Issues: Open an issue specifically for documentation problems
Built with ❤️ by the Arc programming language team.