https://github.com/flosciante/docus-starter

https://github.com/flosciante/docus-starter

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/flosciante/docus-starter
• Owner: Flosciante
• Created: 2023-01-26T11:25:27.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-09T15:45:05.000Z (about 1 month ago)
• Last Synced: 2024-10-17T20:03:00.692Z (about 1 month ago)
• Language: TypeScript
• Size: 992 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• 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).