https://github.com/sequelize/website
Our beloved website that contains all versions of our documentations and the API references.
https://github.com/sequelize/website
hacktoberfest
Last synced: 10 months ago
JSON representation
Our beloved website that contains all versions of our documentations and the API references.
- Host: GitHub
- URL: https://github.com/sequelize/website
- Owner: sequelize
- Created: 2022-03-12T18:02:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:27:32.000Z (about 1 year ago)
- Last Synced: 2024-10-30T07:21:40.846Z (about 1 year ago)
- Topics: hacktoberfest
- Language: HTML
- Homepage: https://sequelize.org
- Size: 28.6 MB
- Stars: 29
- Watchers: 8
- Forks: 155
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# sequelize.org
Sequelize's documentation website
This website is built using [Docusaurus 2](https://docusaurus.io/).
### Installation
```bash
# install local dependencies using yarn
yarn
# download the sequelize repository (used for including tested code snippets & generating jsdoc)
yarn sync
```
### Local Development
```bash
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER= yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.