Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parsajiravand/nuxt-content-standalone
Setup documentation in your app with a sidebar feature, table of contents, and more, without setting `documentDriven` to `true` for Nuxt Content.
https://github.com/parsajiravand/nuxt-content-standalone
Last synced: about 1 month ago
JSON representation
Setup documentation in your app with a sidebar feature, table of contents, and more, without setting `documentDriven` to `true` for Nuxt Content.
- Host: GitHub
- URL: https://github.com/parsajiravand/nuxt-content-standalone
- Owner: parsajiravand
- License: mit
- Created: 2023-06-10T23:06:49.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-06-25T15:06:32.000Z (over 1 year ago)
- Last Synced: 2024-05-01T12:39:43.572Z (9 months ago)
- Language: Vue
- Size: 938 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nuxt Content Standalone
> Setup documentation in your app with a sidebar feature, table of contents, and more, with setting `documentDriven` to `false` for Nuxt Content.
## Description
"Nuxt Content Standalone" is a package that allows you to easily integrate a documentation system into your Nuxt.js application. It provides a sidebar feature, table of contents, and various customization options. The package works with Nuxt Content, even if the `documentDriven` option is `false`.
📚Document ・
🚧 Demos ・
🚧 Playground
## 🚀Features
- Don't need to create project for your documentation.
- It has a sidebar, table of contents and more features.
- +50 Components ready to build rich pages
- Start from a README, scale to a framework documentation
- Navigation and Table of Contents generation
- Fully configurable design system
- Leverages Typography and Elements
- Used on Content Documentation
- Powered by Nuxt Content
- Easy to use in your main project.
- tailwindcss support
## Installation
You can install the package via npm:
```shell
npm install nuxt-content-stand
```
or using Yarn:
```shell
yarn add nuxt-content-stand
```
## Usage
- To use "Nuxt Content Stand" in your Nuxt application, follow these steps:
- Install the package as mentioned in the installation section.
- Import and register the plugin in your Nuxt configuration file (nuxt.config.ts):
```ts
export default defineNuxtConfig({
extends: "nuxt-content-stand",
});
```
- Create your documentation content in the content directory of your Nuxt.js project. Follow the guidelines and conventions provided by Nuxt Content.
- For more detailed instructions and examples, please refer to the documentation of Nuxt Content Stand.
## 🔧 Documentation
The complete documentation for "Nuxt Content Stand" can be found at https://nuxt-content-stand.netlify.app/.
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request on the GitHub repository.
## License
This package is open source and available under the MIT License.