https://github.com/codatio/codat-docs
Build deeper connections with business customers
https://github.com/codatio/codat-docs
api codat documentation docusaurus
Last synced: 11 months ago
JSON representation
Build deeper connections with business customers
- Host: GitHub
- URL: https://github.com/codatio/codat-docs
- Owner: codatio
- License: apache-2.0
- Created: 2023-02-04T23:50:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T10:03:35.000Z (11 months ago)
- Last Synced: 2025-04-09T11:22:08.898Z (11 months ago)
- Topics: api, codat, documentation, docusaurus
- Language: SCSS
- Homepage: https://docs.codat.io/
- Size: 134 MB
- Stars: 19
- Watchers: 7
- Forks: 38
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: docs/support/get-help.mdx
Awesome Lists containing this project
README
# Codat docs
The official [Codat](https://codat.io) documentation.
- [Browse the docs](https://docs.codat.io/)
- [Contributing Guide](./CONTRIBUTING.md)
- [OpenAPI Spec](https://github.com/codatio/oas)
 [](https://github.com/codatio/codat-docs/actions/workflows/linknator.yml)
---
## Running locally
### Prerequisites
#### Git LFS
This website uses [Git Large File Storage] (LFS) to efficiently store images. You need to install Git LFS.
```
brew install git-lfs
git lfs install
```
All `.jpg`, `.jpeg`, and `.png` files are tracked.
[Read more](https://git-lfs.com/)
#### Create a .env file
The docusaurus config expects certain environment variables to be defined. We've included `.env.example` - copy this and rename it to `.env`. You can enter any random string for the IDs.
```
copy .env.example .env # on Windows
cp .env.example .env # on Mac
```
### Install npm dependencies
```sh
npm install
```
### Run the project
```sh
npm run start
```
### Editing article markdown files
`/docs`
---
Updates feed:
---
Built with [Docusaurus](https://docusaurus.io/).