Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zackha/terodon
https://github.com/zackha/terodon
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/zackha/terodon
- Owner: zackha
- License: mit
- Created: 2023-01-25T07:00:12.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T12:40:22.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T00:13:25.618Z (8 months ago)
- Language: Vue
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://docus.dev)
## Docus
[![npm version][npm-version-src]][npm-version-href]
[![License][license-src]][license-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Volta][volta-src]][volta-href]
> Docus is the fastest way to create document-driven websites.
- [📄 Documentation](https://docus.dev)
- [⚡️ Play on StackBlitz](https://stackblitz.com/github/nuxt-themes/docus-starter)
## Start a project with Docus
You can use [this template](https://github.com/nuxt-themes/docus-starter) 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 ✨
- **+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)
## They are using it 🎨
- [nuxt/http](https://github.com/nuxt/http)
- [nuxt/content](https://github.com/nuxt/content)
- [nuxt/image](https://github.com/nuxt/image)
- [nuxt-modules/tailwindcss](https://github.com/nuxt-modules/tailwindcss)
- [nuxt-modules/strapi](https://github.com/nuxt-modules/strapi)
- [nuxt-modules/sanity](https://github.com/nuxt-modules/sanity)
- [nuxt-modules/i18n](https://github.com/nuxt-modules/i18n)
- [nuxt-modules/color-mode](https://github.com/nuxt-modules/color-mode)
- [nuxt-modules/apollo](https://github.com/nuxt-modules/apollo)
- [nuxt-community/ackee-module](https://github.com/nuxt-community/ackee-module)
- [hubble-exchange/docs](https://github.com/hubble-exchange/docs)
- [sidebase](https://sidebase.io)
- [haraka](https://github.com/haraka/haraka.github.io)
- [pinia-orm](https://github.com/CodeDredd/pinia-orm)
- [Do you use Docus? Get listed here!](https://github.com/nuxt-themes/docus/issues/713)
## Contributing 🙏
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Run `npm run prepare` to generate type stubs.
4. Use `npm run dev` to start [playground](./playground) in development mode.
## License 📎
[MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/@nuxt-themes/docus/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt-themes/docus
[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt-themes/docus.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxt-themes/docus
[license-src]: https://img.shields.io/github/license/nuxt-themes/docus.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt-themes/docus/blob/main/LICENSE
[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt-themes/docus?utm_source=readme_docus