mirror of
https://github.com/nestriness/nestri.git
synced 2025-12-12 08:45:38 +02:00
390ee2ac0f
I have made documentation for Nestri, so everybody easy can find instructions to get started. It will also make it easier for people to help contribute to the documentation. The documentation is built with Nuxt3, [Docus ](https://github.com/nuxt-themes) which uses Nuxt Content.  
48 lines
807 B
Markdown
48 lines
807 B
Markdown
# Docus
|
|
|
|
## Setup
|
|
|
|
Install dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm run 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
|
|
npm 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
|
|
npm run 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).
|