diff --git a/README.md b/README.md index 6dcc226d9..8b60e34c9 100644 --- a/README.md +++ b/README.md @@ -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 🙏