https://github.com/nuxt-themes/docus-docs-starter

Starter template for Docus.
https://github.com/nuxt-themes/docus-docs-starter

docus template

Last synced: 14 days ago
JSON representation

Starter template for Docus.

• Host: GitHub
• URL: https://github.com/nuxt-themes/docus-docs-starter
• Owner: nuxt-themes
• Created: 2021-01-19T16:25:54.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-10T23:50:30.000Z (4 months ago)
• Last Synced: 2024-08-11T00:37:20.300Z (4 months ago)
• Topics: docus, template
• Language: TypeScript
• Homepage: https://docus.dev
• Size: 1.3 MB
• Stars: 90
• Watchers: 5
• Forks: 21
• Open Issues: 9
• 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://nuxt.com/docs/getting-started/deployment#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).