https://github.com/api7/docs.apiseven.com
https://github.com/api7/docs.apiseven.com
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/api7/docs.apiseven.com
- Owner: api7
- License: apache-2.0
- Created: 2023-03-14T07:14:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T13:43:54.000Z (over 1 year ago)
- Last Synced: 2024-05-19T14:45:49.156Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://docs.apiseven.com
- Size: 9.35 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API7.ai's Documentation Website
This repository contains the source content and codes for [API7.ai](https://docs.apiseven.com/)'s documentation website. It's built using [Docusaurus 2](https://docusaurus.io/) and deployed with API7.ai's infrastructure.
### Run Locally
```
$ npm i
$ npm run start
$ npm run build
```
### How to add new project?
Refer to https://github.com/api7/docs/pull/45
### How to add new document?
> Docusaurus's Official Documents: https://docusaurus.io/docs/create-doc
1. Git clone this repository.
```bash
git clone git@github.com:api7/docs.apiseven.com.git
```
2. Create a new branch.
```bash
# Replace $BRANCH_NAME with your branch name
git checkout -b $BRANCH_NAME
```
3. Create a new file in the corresponding directory, for example, `enterprise_versioned_docs/version-xxx/xxx.md`. For the markdown format, please refer to `docs/enterprise/demo.md`.
4. Add the file to the corresponding sidebar, for example, `enterprise_versioned_sidebars/version-xxx-sidebars.json`. If the sidebar does not exist, create a new one.
5. Commit and push your changes.