History

mrjvs 787862e10c Initialize docs		2023-09-14 20:39:04 +02:00
..
content	Initialize docs	2023-09-14 20:39:04 +02:00
public	Initialize docs	2023-09-14 20:39:04 +02:00
.eslintignore	Initialize docs	2023-09-14 20:39:04 +02:00
.eslintrc.cjs	Initialize docs	2023-09-14 20:39:04 +02:00
.gitignore	Initialize docs	2023-09-14 20:39:04 +02:00
.npmrc	Initialize docs	2023-09-14 20:39:04 +02:00
README.md	Initialize docs	2023-09-14 20:39:04 +02:00
app.config.ts	Initialize docs	2023-09-14 20:39:04 +02:00
nuxt.config.ts	Initialize docs	2023-09-14 20:39:04 +02:00
package.json	Initialize docs	2023-09-14 20:39:04 +02:00
pnpm-lock.yaml	Initialize docs	2023-09-14 20:39:04 +02:00
renovate.json	Initialize docs	2023-09-14 20:39:04 +02:00
tokens.config.ts	Initialize docs	2023-09-14 20:39:04 +02:00
tsconfig.json	Initialize docs	2023-09-14 20:39:04 +02:00

README.md

Docus Starter

Starter template for Docus.

Clone

Clone the repository (using nuxi):

npx nuxi init -t themes/docus

Setup

Install dependencies:

yarn install

Development

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.

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.

yarn generate

Preview build

You might want to preview the result of your build locally, to do so, run the following command:

yarn preview

For a detailed explanation of how things work, check out Docus.