Skip to content

Commit 8a33c99

Browse files
authoredDec 12, 2024··
Replace placeholder site with Docusaurus (#3)
Includes draft docs for public launch
1 parent 9fa7ee4 commit 8a33c99

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+19599
-5613
lines changed
 

‎.gitignore

+17-21
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
pnpm-debug.log*
8-
lerna-debug.log*
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
96

10-
node_modules
11-
dist
12-
dist-ssr
13-
*.local
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
1410

15-
# Editor directories and files
16-
.vscode/*
17-
!.vscode/extensions.json
18-
.idea
11+
# Misc
1912
.DS_Store
20-
*.suo
21-
*.ntvs*
22-
*.njsproj
23-
*.sln
24-
*.sw?
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
1-
# Landing Page for CodeGate
1+
# CodeGate docs
22

3-
Landing page and documentation site for the CodeGate Project
3+
This repository contains the public-facing docs for CodeGate, hosted at
4+
[https://docs.codegate.ai](https://docs.codegate.ai).
45

5-
![Picture of website in Light mode](./images/light.png)
6+
## Local Development
67

7-
![Picture of website in Dark mode](./images/dark.png)
8+
```bash
9+
npm install
10+
npm run start
11+
```
812

9-
# React + Vite
13+
This command starts a local development server and opens up a browser window.
14+
Most changes are reflected live without having to restart the server.
1015

11-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
16+
## Build
1217

13-
Currently, two official plugins are available:
18+
```bash
19+
npm run build
20+
```
1421

15-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
16-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
22+
This command generates static content into the `build` directory.
23+
24+
## About
25+
26+
This site is built with [Docusaurus](https://docusaurus.io/), a modern static
27+
website generator.

0 commit comments

Comments
 (0)
Please sign in to comment.