https://github.com/1998code/docus
Docus is the fastest way to create document-driven websites.
https://github.com/1998code/docus
Last synced: 18 days ago
JSON representation
Docus is the fastest way to create document-driven websites.
- Host: GitHub
- URL: https://github.com/1998code/docus
- Owner: 1998code
- Created: 2023-06-12T09:45:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T15:36:04.000Z (almost 3 years ago)
- Last Synced: 2025-10-29T01:19:57.517Z (9 months ago)
- Language: TypeScript
- Size: 2.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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).