https://github.com/huntersofbook/opensource-docs
https://github.com/huntersofbook/opensource-docs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/huntersofbook/opensource-docs
- Owner: huntersofbook
- License: mit
- Created: 2023-05-24T08:43:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T02:50:42.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:12:12.970Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://huntersofbook.vercel.app
- Size: 721 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docus Starter
Starter template for [Docus](https://docus.dev).
## Clone
Clone the repository (using `nuxi`):
```bash
npx nuxi init -t themes/docus
```
## Setup
Install dependencies:
```bash
yarn install
```
## Development
```bash
yarn dev
```
## Edge Side Rendering
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
```bash
yarn build
```
## Static Generation
Use the `generate` command to build your application.
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
```bash
yarn generate
```
## Preview build
You might want to preview the result of your build locally, to do so, run the following command:
```bash
yarn preview
```
---
For a detailed explanation of how things work, check out [Docus](https://docus.dev).