mirror of
https://github.com/sussy-code/smov.git
synced 2024-12-29 16:07:40 +01:00
cec0744907
Co-authored-by: Jip Frijlink <JipFr@users.noreply.github.com> Co-authored-by: William Oldham <github@binaryoverload.co.uk>
57 lines
952 B
Markdown
Executable file
57 lines
952 B
Markdown
Executable file
# 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).
|