https://github.com/marvelsq/nuxt-docus

Docus is the fastest way to create document-driven websites.
https://github.com/marvelsq/nuxt-docus

Last synced: about 1 month ago
JSON representation

Docus is the fastest way to create document-driven websites.

• Host: GitHub
• URL: https://github.com/marvelsq/nuxt-docus
• Owner: MarvelSQ
• Created: 2023-06-21T02:46:06.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-09T13:53:00.000Z (10 months ago)
• Last Synced: 2024-01-09T15:02:34.582Z (10 months ago)
• Language: TypeScript
• Size: 744 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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).