dev
/
docs
mirror of https://github.com/sussy-code/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs...
5 Commits 1 Branch 0 Tags 3 MiB
MDX 86%
TypeScript 13.5%
CSS 0.3%
JavaScript 0.2%
Go to file
mrjvs 31690529eb Add navigation page titles 2023-12-12 19:36:07 +01:00
content Add navigation page titles 2023-12-12 19:36:07 +01:00
public Add Docs 2023-12-11 22:11:39 +00:00
.eslintignore Add Docs 2023-12-11 22:11:39 +00:00
.eslintrc.cjs Add Docs 2023-12-11 22:11:39 +00:00
.gitignore Add Docs 2023-12-11 22:11:39 +00:00
.npmrc Add Docs 2023-12-11 22:11:39 +00:00
LICENSE Initial commit 2023-12-11 22:03:58 +00:00
README.md Add Docs 2023-12-11 22:11:39 +00:00
app.config.ts Add Docs 2023-12-11 22:11:39 +00:00
nuxt.config.ts Add Docs 2023-12-11 22:11:39 +00:00
package.json Add Docs 2023-12-11 22:11:39 +00:00
pnpm-lock.yaml Add Docs 2023-12-11 22:11:39 +00:00
renovate.json Add Docs 2023-12-11 22:11:39 +00:00
tokens.config.ts Add Docs 2023-12-11 22:11:39 +00:00
tsconfig.json Add Docs 2023-12-11 22:11:39 +00: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.