https://github.com/idep-network/idep-docs
Official repo for IDEP Networks documentation
https://github.com/idep-network/idep-docs
docs docusaurus2
Last synced: about 2 months ago
JSON representation
Official repo for IDEP Networks documentation
- Host: GitHub
- URL: https://github.com/idep-network/idep-docs
- Owner: IDEP-network
- Created: 2021-04-09T14:22:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T00:22:25.000Z (about 2 years ago)
- Last Synced: 2025-02-09T02:34:21.826Z (3 months ago)
- Topics: docs, docusaurus2
- Language: HTML
- Homepage:
- Size: 120 MB
- Stars: 1
- Watchers: 3
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# IDEP Docs
IDEP Docs was built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Getting the repository
```console
git clone https://github.com/IDEP-network/IDEP-Docs.git
```
## Installation
```console
npm install
```
## Local Development
```console
npm run start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
## Build
```console
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
:exclamation::exclamation: You need to build your changes before you commit to the repository for the updates to take effect :exclamation::exclamation:
## Deployment
```console
GIT_USER= USE_SSH=true 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.