Skip to content
Snippets Groups Projects
Commit 1e82cffb authored by Remi  PLANEL's avatar Remi PLANEL
Browse files

update readme

parent b00beca6
No related branches found
No related tags found
No related merge requests found
Pipeline #110680 passed
......@@ -8,3 +8,4 @@ node_modules
.output
.env
dist
*.code-workspace
\ No newline at end of file
# Docus Starter
# Content v2 Minimal Starter
Starter template for [Docus](https://docus.dev).
## Clone
Clone the repository (using `nuxi`):
```bash
npx nuxi init -t themes/docus
```
Look at the [Content documentation](https://content-v2.nuxtjs.org/) to learn more.
## Setup
Install dependencies:
Make sure to install the dependencies:
```bash
# yarn
yarn install
```
Using docker:
# npm
npm install
```bash
docker run -v "$PWD":/usr/src/app -w /usr/src/app --user 1000:1000 node:19.5-bullseye-slim npm install
# pnpm
pnpm install
```
## Development
## Development Server
```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).
Start the development server on http://localhost:3000
```bash
yarn build
npm run dev
```
## Static Generation
Use the `generate` command to build your application.
## Production
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
Build the application for production:
```bash
yarn generate
npm run build
```
## Preview build
You might want to preview the result of your build locally, to do so, run the following command:
Locally preview production build:
```bash
yarn preview
npm run preview
```
---
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment) for more information.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment