Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxt-community/nuxtent-module
Seamlessly use content files in your Nuxt.js sites.
https://github.com/nuxt-community/nuxtent-module
automatic-navigation content-management nuxt nuxt-module
Last synced: about 2 months ago
JSON representation
Seamlessly use content files in your Nuxt.js sites.
- Host: GitHub
- URL: https://github.com/nuxt-community/nuxtent-module
- Owner: nuxt-community
- License: mit
- Archived: true
- Created: 2017-06-21T07:34:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-01T16:19:07.000Z (over 3 years ago)
- Last Synced: 2024-07-22T17:59:29.700Z (about 2 months ago)
- Topics: automatic-navigation, content-management, nuxt, nuxt-module
- Language: TypeScript
- Homepage: https://nuxtent-module.netlify.com/guide
- Size: 2.99 MB
- Stars: 390
- Watchers: 19
- Forks: 50
- Open Issues: 77
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Deprecated :warning:
Nuxtent has been deprecated, please checkout Nuxt Content: https://content.nuxtjs.org
---
Nuxtent
Seamlessly use content files in your Nuxt.js sites.
https://nuxtent-module.netlify.com/guide
[📖 Release Notes](./CHANGELOG.md)
**This is a work in progress from integrating [nuxtdown](https://github.com/joostdecock/nuxtdown-module) features and fixing critical bugs. DO NOT USE IN PRODUCTION**
# Summary
The goal of Nuxtent is to make using Nuxt for content heavy sites as easy as using Jekyll, Hugo, or any other static site generator.
Nuxtent mainly does this in two ways:
1. By compiling all the data from `markdown` or `yaml` files based on configured rules.
2. By providing helpers for dynamically accessing this data inside Nuxt pages.
But, we didn't just want to make Nuxtent as good as a static site generator–we wanted to make it better.
So, along with that, Nuxtent also supports:
3. The usage of content files in both static sites and dynamic applications.
4. The usage of `Vue components` inside markdown files.
5. Automatic content navigation, between pages via `path` and within pages via `anchors`.
There you go: five reasons to give `Nuxtent` a try, and maybe even star and [share]("https://twitter.com/intent/tweet) it. :smirk:
# Features
- Simple configuration
- Allows you to override settings for the markdown parser ([markdown-it](https://github.com/markdown-it/markdown-it)), and use its plugins
- Support both blog posts or similar flat content structures, and a nested hierarchy of markdown content
- Adds useful info to your markdown page's meta info, including:
- Any data your specify in the config file
- A breadcrumbs trail for hierarchical markdown content
- (the info for) a table of contents
- Support for using vue components inside your markdown content
- Adds the $content helper to Nuxt to allow your to access your markdown content and metadata inside Nuxt pages
# v3.X goals
- [ ] Improve the documentation and at least a spanish translation
- [-] Windows compatible (Help needed)
- [ ] Be zeroconf and extendible through it's own api and exposing the markdown parser
- [ ] Allow default attributes to be set on the frontmatter ej. title
- [ ] Real async modules (this affects ssr more than a static build)
- [ ] Fully integrate with the new features nuxt2.0 and node 11
- [ ] Debugable configuration
- [ ] Better error reporting
- [ ] Improve the template with optional addons as examples
- [ ] Document the code in order to simplify contributions and future development
- [ ] Support multiple file types
- [ ] Integrate the api configuration with nuxt itself while keeping it configurable
- [x] Expose $content helper and it's constant like api endpoint through all of vue
- [ ] Vuex integration
- [-] Improve on SSR memory usage
- [ ] Keep the main features from nuxtdown:
- [ ] Breadcrubms
- [ ] Automatic table of content (TOC)
- [ ] Isolated and global configurations
- [ ] Allow for nested content and index files
## Simple yet flexible API
Nuxtent was created to integrate with Nuxt (otherwise, you're just building another Jekyll-like tool, with the same amount of mental overhead).
Nuxtent's API is simple yet flexible. All you have to do is
- Configure the content and
- Fetch the files with the `$content` helper inside the `asyncData` method that is available in Nuxt pages.
Here's a basic example:
```js
// nuxtent.config.js
module.exports = {
content: {
page: '/_post',
permalink: ':year/:slug'
}
}
```
```js
// pages/_post.vue
export default {
asyncData: async ({ app, route }) => ({
post: await app.$content('posts').get(route.path)
})
}
```
The response for each item is:
``` json
{
}
```
## Quick Start
If you're starting a new site, you can use the [nuxtent-starter](https://github.com/nuxt-community/content-template) template.
``` bash
$ vue init nuxt-community/nuxtent-template my-site
$ cd my-site
# install dependencies
$ npm install # Or yarn install
```
Or if you already have your nuxt project:
## Installation
```
npm install nuxtent --save
```
Then, under `nuxt.config.js` install the module:
```
modules: [
'nuxtent'
]
```
## Documentation
Documentation available at: https://nuxtent-module.netlify.com/guide (built with Nuxtent).
## Sites built with Nuxtent
*Have a site using Nuxtent? Fork the repo and add it to the list below!*
### Personal Sites
- [alidcastano.com](https://alidcastano.com/) [source](https://github.com/alidcastano/alidcastano)
- [patternworks.com.au](https://patternworks.com.au/) [source](https://github.com/callumflack/patternworks-2018)
- [askcreative.space](https://askcreative.space) [source](https://github.com/askcreative/asksite)
- [mat.services](https://mat.services) [source](https://gitlab.com/matthewess/mat.services)
### Documentation Sites
- [ency.now.sh](https://ency.now.sh/) [source](https://github.com/encyjs/docs)
### Corporate Sites
- [dinamo.mx](https://dinamo.mx)
- [yagodemarta.com](https://yagodemarta.com)
- []
## License
[MIT License](./LICENSE)
Copyright (c) 2017 Nuxt Community