https://github.com/exafunction/codeium-docs
Docs for Codeium, the modern coding superpower
https://github.com/exafunction/codeium-docs
Last synced: 10 months ago
JSON representation
Docs for Codeium, the modern coding superpower
- Host: GitHub
- URL: https://github.com/exafunction/codeium-docs
- Owner: Exafunction
- Created: 2024-08-27T18:50:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-04T22:41:08.000Z (about 1 year ago)
- Last Synced: 2024-12-04T23:26:29.718Z (about 1 year ago)
- Language: MDX
- Size: 29 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codeium Docs
Welcome to the Codeium docs page source code.
The docs serve as a reference point for Codeium usage, across all surfaces of the product:
our VS Code extension, our JetBrains plugin, our PR review system Forge, our Chrome extension, our Enterprise deployment guides, and more.
It is currently under construction!
### Development
We use [Mintlify](https://mintlify.com/) as our docs provider.
To develop locally and preview the changes, install the [Mintlify CLI](https://www.npmjs.com/package/mintlify).
```bash
npm i mintlify
```
Run the following command at the root of this repo (where `mint.json` is)
```bash
npx mintlify dev
```
#### Troubleshooting
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`