https://github.com/captv89/helpportal
A Simple Help Documentation & Video Portal made from Docusaurus v2
https://github.com/captv89/helpportal
documentation docusaurus2 guide reactjs video
Last synced: about 1 year ago
JSON representation
A Simple Help Documentation & Video Portal made from Docusaurus v2
- Host: GitHub
- URL: https://github.com/captv89/helpportal
- Owner: captv89
- Created: 2021-03-26T03:22:39.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-02T08:18:17.000Z (almost 5 years ago)
- Last Synced: 2025-01-08T23:48:47.768Z (over 1 year ago)
- Topics: documentation, docusaurus2, guide, reactjs, video
- Language: JavaScript
- Homepage: https://captv89.github.io/HelpPortal/
- Size: 851 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn 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
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ 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.
### Continuous Integration
Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.
```
$ yarn ci
```
### To Generate Document Version
For every offical release, baselining the document and version to be done.
- First, make sure your content in the docs directory is ready to be frozen as a version. A version always should be based from master.
- Enter a new version number.
```
yarn run docusaurus docs:version 1.1.0
```
### To Generate PDF from the Site
Keep the site hosted in local and run the below.
```
npx docusaurus-pdf http://localhost:3000/Help/docs/greeting/ 3.2.0.pdf
```