Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul committed Nov 16, 2022
1 parent fe3d3e9 commit bfba7fc
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,38 @@

> Docus is the fastest way to create document-driven websites.
https://docus.dev (password: `ilovenuxt`)
[📄 Documentation](https://docus.dev)

## Start a project with Docus

You can use [this template] to create a new project.

If you want to add Docus to an existing codebase, you can do so with:

- Install the dependency:

```bash
npm install @nuxt-themes/docus
```

- Add it to your extends key in `nuxt.config`:

```ts
defineNuxtConfig({
extends: '@nuxt-themes/docus'
})
```

## Features ✨

- Write your document with Markdown and built-in Vue components
- Powered by Nuxt 3
- Emoji Support
- Custom SVG support (via Vue component)
- **+50 Components** ready to build rich pages
- **Article**, **Docs** and **Blog** layouts
- Start from a `README`, scale to a framework documentation
- Table of contents support
- Configurable design system integration
- Replace, extend, customize any component in a breeze
- Leverages [**@nuxt-themes/typography**](https://github.com/nuxt-themes/typography)
- Used on [Content Documentation](https://content.nuxtjs.org)

## Contributing 🙏

Expand Down

1 comment on commit bfba7fc

@vercel
Copy link

@vercel vercel bot commented on bfba7fc Nov 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.