https://github.com/covenantsql/docs
CovenantSQL docs
https://github.com/covenantsql/docs
Last synced: 6 months ago
JSON representation
CovenantSQL docs
- Host: GitHub
- URL: https://github.com/covenantsql/docs
- Owner: CovenantSQL
- Created: 2018-12-19T14:35:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T18:30:48.000Z (almost 3 years ago)
- Last Synced: 2023-08-13T05:10:41.636Z (over 2 years ago)
- Language: JavaScript
- Homepage: https://developers.covenantsql.io
- Size: 5.6 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CovenantSQL Docs
Documentation of CovenantSQL and related tools, build with [Docusaurus](https://github.com/facebook/Docusaurus).
## Docs update
### docs
Update markdown docs in `/docs` folder, and make sure every doc file has the header
structure as following:
```
---
id: $doc_id
title: $doc_title
---
```
### sidebar
Update sidebar from `website/sidebars.json`:
```
{
"docs": {
"Intro": [ // category name
"intro" // doc_id
],
...
"About": [
"usecase",
"qna"
]
}
}
```
## Publish
### before publish
- install [`yarn`](https://yarnpkg.com/lang/en/docs/install/)
- install node module dependencies `cd website && yarn install`
### ship
- `chmod +x ./ship.sh`
- `./ship.sh -v $version -u $github_username`