https://github.com/hoowc/hdocs

Program documentation, a website for novice learners
https://github.com/hoowc/hdocs

Last synced: 6 days ago
JSON representation

Program documentation, a website for novice learners

• Host: GitHub
• URL: https://github.com/hoowc/hdocs
• Owner: HooWC
• Created: 2024-11-02T13:24:20.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2024-11-02T16:17:06.000Z (about 2 months ago)
• Last Synced: 2024-11-02T17:21:08.289Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://h-docs.vercel.app
• Size: 578 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```

$ yarn

```

### Local Development

```

$ 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

```

$ yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```

$ USE_SSH=true yarn deploy

```

Not using SSH:

```

$ 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.