Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dword-design/nuxt-content-body-html
Adds a property to each @nuxt/content document containing the raw HTML body, rendered from markdown.
https://github.com/dword-design/nuxt-content-body-html
body feed nuxt nuxt-content nuxt-module nuxtjs rss
Last synced: 19 days ago
JSON representation
Adds a property to each @nuxt/content document containing the raw HTML body, rendered from markdown.
- Host: GitHub
- URL: https://github.com/dword-design/nuxt-content-body-html
- Owner: dword-design
- License: other
- Created: 2021-07-16T17:17:53.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T05:05:48.000Z (about 2 months ago)
- Last Synced: 2024-10-17T18:13:35.666Z (29 days ago)
- Topics: body, feed, nuxt, nuxt-content, nuxt-module, nuxtjs, rss
- Language: JavaScript
- Homepage:
- Size: 1.75 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# nuxt-content-body-html
Adds a property to each @nuxt/content document containing the raw HTML body, rendered from markdown.
## Install
```bash
# npm
$ npm install nuxt-content-body-html
# Yarn
$ yarn add nuxt-content-body-html
```
Sometimes you need the raw HTML code of `@nuxt/content` documents for processing. A frequent use case is to generate an RSS feed and to add the HTML as `content:encoded`. The module will use the default remark and rehype plugins. You can also add additional plugins.
## Nuxt 3
Add the module to your `nuxt.config.js` file:
```js
export default {
modules: [
'@nuxt/content',
'nuxt-content-body-html',
},
}
```
To generate the HTML, you have two options: 1. Add fields to the module config and 2. use the `useNuxtContentBodyHtml` composable. If you just need a simple HTML version of your markdown content, the module config is fine. But if you want to add extra remark or rehype plugins involving functions, you will need to use the composable because Nuxt won't be able to serialize it into the runtime config.
### Module config
```js
export default {
modules: [
'@nuxt/content',
['nuxt-content-body-html', {
fields: {
bodyHtml: {},
},
}],
},
}
```
This is the simplest way of generating the `bodyHtml` field into the file objects.
### Composable
Add a Nitro plugin to `server/plugins`. We will hook into `content:file:beforeParse` and add our HTML code by calling the composable. Unfortunately, there is currently an [open issue in @nuxt/content](https://github.com/nuxt/content/issues/2056) that does not persist variables added in `content:file:beforeParse`. So we will have to store them and restore them in `content:file:afterParse`. Hopefully this will be fixed soon.
```js
// server/plugins/body-html.js
import { defineNitroPlugin, useNuxtContentBodyHtml } from '#imports'
const nuxtContentBodyHtml = useNuxtContentBodyHtml()
export default defineNitroPlugin(nitroApp => {
const bodyHtmls = {}
nitroApp.hooks.hook('content:file:beforeParse', async file =>
bodyHtmls[file._id] = await nuxtContentBodyHtml.generate(file)
)
nitroApp.hooks.hook('content:file:afterParse', file => (file.bodyHtml = bodyHtmls[file._id]))
})
```
### Adding Remark and Rehype plugins
In some cases you will want to add additional plugins to customize the HTML. E.g. in an RSS feed you want to have absolute URLs. You can add plugins to the field configs and the composable like so:
```js
export default {
modules: [
'@nuxt/content',
['nuxt-content-body-html', {
fields: {
bodyHtml: {
remarkPlugins: {
'remark-foo': {},
},
rehypePlugins: {
'rehype-foo: {},
},
},
},
}],
},
}
```
```js
await useNuxtContentBodyHtml.generate(file, {
remarkPlugins: {
'remark-foo': {},
},
rehypePlugins: {
'rehype-foo: {},
},
})
```
### Enabling the highlighter
You can easily enable syntax highlighting like so:
```js
export default {
modules: [
'@nuxt/content',
['nuxt-content-body-html', {
fields: {
bodyHtml: { highlight: true },
},
}],
},
}
```
```js
await useNuxtContentBodyHtml.generate(file, { highlight: true })
```
## Nuxt 2 and @nuxt/content@^1
`nuxt-content-body-html` works similarly for Nuxt 2 with some minor differences. Firstly, you need to add the module to your `nuxt.config.js` file **before** `@nuxt/content`:
```js
export default {
modules: [
'nuxt-content-body-html',
'@nuxt/content',
},
}
```
Then, the HTML code will be generated in module context and not in Nitro context, so you can completely configure your fields via the module config and you do not need a composable.
For convenience, if you do not configure any field, a `bodyHtml` field will be configured by default. So the above config will already generate a field.
To add fields or have a different name for the field, you can add fields like so:
```js
export default {
modules: [
['nuxt-content-body-html', {
fooHtml: {},
}],
'@nuxt/content',
],
}
```
### Plugins
You can also add plugins to the config. Note that the plugins are arrays:
```js
export default {
modules: [
['nuxt-content-body-html', {
fooHtml: {
remarkPlugins: [
'plugin1',
['plugin2', { /* options */ }],
],
rehypePlugins: [
'plugin1',
['plugin2', { /* options */ }],
],
},
}],
'@nuxt/content',
],
}
```
### Overriding or disabling the highlighter
In `@nuxt/content^1` the highlighter is enabled by default. You can explicitly override or disable the highlighter by setting it in the config:
```js
export default {
modules: [
['nuxt-content-body-html', {
// Pass a custom highlighter
highlighter: customHighlighter,
// Disable the highlighter by setting a noop function
highlighter: code => `
${code}
`,
}],
'@nuxt/content',
],
}
```
## Usage for RSS feeds
You can customize the module so that you can use the resulting HTML code for RSS feeds.
Firstly, RSS feeds require URLs to be absolute. You can use [rehype-urls](https://github.com/brechtcs/rehype-urls) to make relative URLs absolute. At the time of writing, the npm version is not compatible with `@nuxt/content@^2`, you will need to fix the issue in [this PR](https://github.com/brechtcs/rehype-urls/pull/3).
```js
// nuxt.config.js
// Set process.env.BASE_URL to the domain to prepend
export default {
runtimeConfig: {
baseUrl: process.env.BASE_URL,
},
modules: [
'@nuxt/content',
'nuxt-content-body-html',
],
}
```
```js
// server/plugins/body-html.js
import { defineNitroPlugin, useNuxtContentBodyHtml, useRuntimeConfig } from '#imports'
const { baseUrl } = useRuntimeConfig()
const nuxtContentBodyHtml = useNuxtContentBodyHtml()
export default defineNitroPlugin(nitroApp => {
const bodyHtmls = {}
nitroApp.hooks.hook('content:file:beforeParse', async file =>
bodyHtmls[file._id] = await nuxtContentBodyHtml.generate(file, {
rehypePlugins: {
'rehype-urls', { transform: url => (url.host ? url : new URL(url.href, baseUrl)) },
},
})
)
nitroApp.hooks.hook('content:file:afterParse', file => (file.bodyHtml = bodyHtmls[file._id]))
})
```
## Contribute
Are you missing something or want to contribute? Feel free to file an [issue](https://github.com/dword-design/nuxt-content-body-html/issues) or a [pull request](https://github.com/dword-design/nuxt-content-body-html/pulls)! ⚙️
## Support
Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:
If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
Here you can support me regularly, which is great so I can steadily work on projects.
Thanks a lot for your support! ❤️
## See also
* [nuxt-content-git](https://github.com/dword-design/nuxt-content-git): Adds a property to each @nuxt/content document containing the raw HTML body, rendered from markdown.
* [nuxt-mail](https://github.com/dword-design/nuxt-mail): Adds email sending capability to a Nuxt.js app. Adds a server route, an injected variable, and uses nodemailer to send emails.
* [nuxt-route-meta](https://github.com/dword-design/nuxt-route-meta): Adds Nuxt page data to route meta at build time.
* [nuxt-modernizr](https://github.com/dword-design/nuxt-modernizr): Adds a Modernizr build to your Nuxt.js app.
* [nuxt-mermaid-string](https://github.com/dword-design/nuxt-mermaid-string): Embed a Mermaid diagram in a Nuxt.js app by providing its diagram string.
## License
[MIT License](https://opensource.org/licenses/MIT) © [Sebastian Landwehr](https://sebastianlandwehr.com)