content

Nuxt Content reads the content/ directory in your project, parses .md, .yml, .csv or .json files and creates a powerful data layer for your application. Bonus, use Vue components in Markdown with the MDC syntax.

3 maintainers

144k installs

3k stars

v2.7.0 by farnabazJune 13, 2023

🚀 Enhancements

shiki: Support italic, bold and underline styles (#2079)
config: Update ignores to advanced pattern (#2035)

🩹 Fixes

link: Remove hash before checking if ending by '.md' (#2033)
markdown: Prevent script execution (#2040)
code-block: Pass language as class name (#2064)
tailwind-integration: Allow content as object (#2060)
code-block: Meta property (#2067)
markdown: Respect _draft key in frontmatter (#2077)

📖 Documentation

Guide for adding custom grammars for syntax highlighting (7da9b286)
Add example of additional sorting options for queryContent (#2042)
Explain useasyncdata wrapping (#2054)
Update url (#2055)
Add latest to nuxi command (2939b793)
Update Content Wind live demo url (#2080)
Update links (#2085)
Remove outdated description (#2098)

🏡 Chore

Use caret dependency for kit (#2044)

❤️ Contributors

TomatoGuy0502 H34066131@gs.ncku.edu.tw
Dave Stewart dave@davestewart.co.uk
Kricsleo
Nobkd
Mukund Shah
Inesh Bose
Stefanprobst stefanprobst@posteo.de
Sébastien Chopin seb@nuxtlabs.com
Clément Ollivier (@clemcode)
YannC
James Tyner
Ashour ashour.mohammad@gmail.com
Daniel Roe daniel@roe.dev

v2.6.0 by farnabazApril 20, 2023

🚀 Enhancements

CodeBlock: Add line number attribute to code block lines (#1973)
More flexible ignores configuration (#2022)

🩹 Fixes

type: Content locale (#1965)
markdown: Html ids in markdown headings should not start with a digit (#1961)
useContentHead: Set property instead of name for OG metadata (#1981)
Access config from public key (#2005)
ContentRendererMarkdown: Prevent undefiend error on component resolve (#2021)
code-block: Use span with \n instead of div for lines (#2008)
preview: Use sessionStorage to keep token (#2020)
shiki: Add \n to empty lines (46f3d79f)
markdown-renderer: Document reactivity (e46309fe)
query: Prevent adding duplicate conditions to query (#2027)
document-driven: Ensure layout is set on hydration (#2032)

📖 Documentation

Add Nuxt Studio link (bc329334)
Fix link to nitro plugins (#1969)
Format docs & update links & fix mistakes (#1982)
Fix template syntax (9d8478de)

❤️ Contributors

Farnabaz farnabaz@gmail.com
Dave Stewart info@davestewart.co.uk
Nobkd
Daniel Roe daniel@roe.dev
Thomas Lamant
Electrolinux electrolinux@gmail.com
Artyom
Sébastien Chopin seb@nuxtjs.com

v2.5.2 by AtinuxMarch 8, 2023

fix: revert navDirFromPath behavior (049c356)

v2.5.1 by farnabazMarch 8, 2023

🩹 Fixes

client-db: Ensure ignoreSources is an array (45b44a69)
document-driven: Page layout detection (#1955)

v2.5.0 by farnabazMarch 8, 2023

compare changes

🚀 Enhancements

Introduce component-resolver transformer (#1907)
client-db: Allow possibility to ignore some sources from client storage (#1917)

🩹 Fixes

Add anchorLinks type (#1894)
headings: Don't generate link if id is missing (#1893)
code block: Use div instead of span (#1885)
Types (#1912)
Db access time issue (#1838)
Refresh content-index on nitro start (#1947)
findSurround: Allow before and after to be 0 (#1922)
module: Close dev server on nitro close (#1952)

📖 Documentation

Remove extraneous comma (#1878)
Update link to useHead (#1895)
Update get-started description (13a2e1cf)
Update content list query example (#1901)
Fix deployment (#1913)
Update documentDriven config (#1915)
Add examples for JSON string for inline props (#1882)
Update badges (737d5c54)
Add github in sources (#1946)

❤️ Contributors

Farnabaz farnabaz@gmail.com
Barbapapazes (@Barbapapazes)
Sébastien Chopin seb@nuxtjs.com
Wolfgang Drescher drescher.wolfgang@gmail.com
Estéban
Patrik
Nobkd
Clément Ollivier (@clemcode)
Ben Hong (@bencodezen)

v2.4.3 by farnabazJanuary 31, 2023

🚀 Enhancements

pnpm: Switch to pnpm (local / ci) (#1868)

🩹 Fixes

query: Decode unicode params (#1871)

❤️ Contributors

Yaël Guilloux yael.guilloux@gmail.com

v2.4.2 by farnabazJanuary 27, 2023

🩹 Fixes

useContentHead: Disable host detection (f6a429dc)

📖 Documentation

Improvements (f1991939)

🏡 Chore

Update release config (801535d2)

❤️ Contributors

Sébastien Chopin seb@nuxtjs.com
Farnabaz farnabaz@gmail.com

v2.4.1 by farnabazJanuary 26, 2023

v2.4.1

compare changes

🩹 Fixes

useContentHead: undefined url (b157500b)

📖 Documentation

Update edit path (#1853)

🏡 Chore

Update changelog (8e7733a0)
Update release config (1bb477d8)

❤️ Contributors

Farnabaz farnabaz@gmail.com
Barbapapazes e.soubiran25@gmail.com

v2.4.0 by farnabazJanuary 25, 2023

🚀 Enhancements

shiki-highlighter: Improve performance & auto load new languages (#1775)
shiki: Highlight excerpt (#1802)
markdown: Keep meta from fenced code block (#1800)
markdown: Don't create excerpt if there is no  (#1801)

🩹 Fixes

build: Do not register web-socket plugin on non-dev env (#1768)
document-driven: Prevent 404 error on redirected pages (#1770)
query: Ensure default values always apply to query params (#1778)
examples: Layout duplication (#1808)
Shiki: Sanitize highlighted text (#1818)
markdown-link: Replacing blank prop with target (#1828)
highlighter: Define missing env in Vite (#1830)
shiki: Issue with JSON import (#1824)
markdown: XSS Prevention (#1832)
Handle uri encoded _path query (#1794)
Add og:title,url,description meta tags and prefix og:image with host (#1769)
navigation: Missing import (6a1e854e)
navigation: Missing import (1f7d3a2b)
markdown: Images src with baseURL (#1833)

📖 Documentation

Update badges (5a2d2871)
Update outdated link in sitemap.md (#1772)
Fix broken quickstart link (#1785)
Fix ContentRenderer source link (#1790)
Fix broken nuxt link (#1789)
Fix ContentDoc multi-slot example (#1815)
Add note about transformer (#1826)
Update logo (f77d7703)

🏡 Chore

Fix typos (b4750ed0)
Update favicon (1cb91f5d)
Add release-it (9a565fde)

✅ Tests

Disable autoImport (#1842)

❤️ Contributors

Daniel Roe daniel@roe.dev
ハン / Han
Sébastien Chopin seb@nuxtjs.com
SheetJSDev dev@sheetjs.com
Arash
Horu
Valery Qwertovsky
GanymedeNil ganymedenil@gmail.com
Nobkd
Issayah github.me.mzu5a@simplelogin.com
PickleNik
Philipp Wagner mail@philipp-wagner.com
Yuki Inoue inoueyuworks@gmail.com

v2.3.0 by farnabazDecember 15, 2022

🚀 Enhancements

module: Introduce api.baseURL and deprecate base (#1695)
Unique api calls per build (#1705)
shiki: Expose highlighting utils (#1727)
document-driven: Introduce start and finish hooks (#1744)
query: Fully cacheable api (#1752) (This could enable under stripQueryParameters experimental flag)

🩹 Fixes

markdown: Resolve custom shiki languages (#1692)
clientDB: Disable clientDB if token is set and has falsy value (#1700)
shiki: Issue with merging multiple themes (#1703)
query: Invalid response on missing content (#1706)
test: Typo (#1707)
markdown: Remove double and trailing dashes from heading ids (#1711)
ws: Prevent port conflict on running multiple instances (#1721)
markdown: Remove extra dash from heading id (4c376587)
Typo (a7912af1)
build: Invalid cache route handler (ae138a87)
ContentRendererMarkdown: Recreate vNodes in render function (#1734)
query: Fallback to default locale if query has no filter on _locale (#1748)
module: Put query parameters removal under an experimental flag (#1757)
Add missing imports (5285db01)

💅 Refactors

ContentRenderer: Simplify conditions (#1715)
Shiki: Prepare Shiki highlighter for external usage (#1720)

📖 Documentation

Update deps (#1684)
Update studio module (fe55ff28)
Revert studio module to 0.2.2 (e26ffd01)
Update studio module (#1686)
Fix typo (#1693)
Upgrade studio module (ff2edddc)
Update code inline (#1730)
Update module options (#1755)

🏡 Chore

Upgrade deps (#1691)
logging: Cleanup logging (#1733)

❤️ Contributors

Farnabaz farnabaz@gmail.com
Yaël Guilloux yael.guilloux@gmail.com
Sébastien Chopin seb@nuxtjs.com
Levi (Nguyễn Lương Huy) huy.nguyen.luong96@gmail.com
Nobkd
Onur Dumangöz
Baptiste Leproux leproux.baptiste@gmail.com

v2.2.2 by farnabazNovember 15, 2022

🩹 Fixes

ContentRenderer: Empty content detection (#1653)
ContentList: Handle props change and fix slots default (#1668)

💅 Refactors

Improve typings and simplify logic (#1669)

📖 Documentation

Fix error in ContentQuery where clause example (#1643)
Update sources (#1664)
a11y: Use list for nav example (#1670)

🏡 Chore

Add #content/context virtual file (6e205703)
No need for virtual file (37e2caf9)
Upgrade deps (#1682)

❤️ Contributors

Farnabaz
Novellac
Sébastien Chopin (@Atinux)
Brett Ormsby

v2.2.1 by farnabazOctober 27, 2022

🩹 Fixes

module: Do not warn when sources is empty (42fffc98)
module: Set default hostname for dev socket (#1624)
Document Driven: Layout prefetching (#1637)
MarkdownParser: Refine content path in anchor link (#1629)

📖 Documentation

Fix typo (#1632)
Fix apostrophe character (#1633)
Fix typo (#1634)

🏡 Chore

Move algolia keys to env (138bb7d4)
Upgrade remark-mdc (#1627)
Upgrade deps (#1640)

❤️ Contributors

Ahad Birang
Nobkd
Selemondev
Sébastien Chopin

v2.2.0 by farnabazOctober 19, 2022

🚀 Enhancements

document-driven: Support navigation.redirect from _dir files (#1545)
Spa mode (#1525)
Config for anchor link generation of headings (#1564)
parser: Introduce _dir field in contents (#1613)

🔥 Performance

build: Build caches before pre-rendering contents (#1530)

🩹 Fixes

module: Make documentDriven configs optional (#1539)
Add missing imports (451b000e)
Missing imports on preview mode (f9f161b1)
Use relative .md link (#1556)
module: Multi-source array (#1578)
navigation: Missing composable when navigation is disabled (#1577)
Ignore built content in preview mode (bc01cde3)
ClientDB: Drop LocalStorage (7afd857b)
client-db: Race-condition on multiple calls (c11a4800)
<ContentList>: Respect query.path when path is missing (#1598)
<ContentDoc>: Render blink in SSG (#1600)
Update h3 usage with explicit defineEventHandler (#1603)
anchorLinks: Add useRuntimeConfig imports (#1605)
runtime: Detect 404 api responses in SSG (#1608)
queryContent: Use path argument as prefix if there is another condition (#1612)

📖 Documentation

Fix type client only -> client-only (#1535)
content-list: Updated query reference and added example (#1548)
Add search (#1575)
Update algolia key (9e91948e)
Cleanup deps (#1582)
Upgrade Content version (c76c5a75)
Broken link on Markdown API page (#1588)
composables: Fix close tag ContentRenderer (#1597)
Update badge style (49b1c4cc)
Update cover (ba2aeb45)
No need to register manually nitro plugin (b6bbb42c)
Fix nitro plugins link (0259a901)
Update findSurround usage (#1609)
Guidance on using local images (#1617)

🏡 Chore

Update deps (d3e9aa70)
Update Docus (428cf8f8)
Add missing dep (5d29a377)
Remove preview plugin (558add0c)

❤️ Contributors

Ahad Birang
Jan-Henrik Damaschke
Michel EDIGHOFFER
Nobkd
Percy Ma
Pooya Parsa
Ramses Garate
Remiconnesson
Sai Deepesh
Sébastien Chopin

v2.1.1 by farnabazSeptember 15, 2022

🩹 Fixes

document-driven: Sync page layout (#1519)
document-driven: Disable static payload (#1526)

📖 Documentation

document-driven: Remove edge channel info (#1462)
Update title & description (#1505)
document-driven: Fix typo (#1512)

❤️ Contributors

Ahad Birang
Nobkd
Okoro Redemption
Sébastien Chopin

v2.1.0 by farnabazSeptember 7, 2022

✨ Highlights

Introducing the Document Driven mode, an easy and powerful way to create Markdown-based websites!
- Demo video
- Online playground
Allow using variables in Markdown contents (#1266)
Improve type support for WebStorm #1288
<Markdown> is deprecated in favor of new <ContentSlot /> component. The usage is the same as before.

🚀 Enhancements

types: Provide augmentations for only and without (#1200)
types: Expose MarkdownParsedContent for improved type generics (#1199)
navigation: Allow passing QueryBuilder or QueryBuilderParams in fetchNavigation or <ContentNavigation> (#1206)
markdown: Allow overwriting plugins (#1226)
config: Allow ws config (#1249)
markdown: Support multiple themes for code highlighter (#1251)
navigation: Allow _dir.yml to filter navigation (#1261)
source: Allow overwriting default source (#1273)
Variable binding (#1266)
document-driven: Add document-driven as a @nuxt/content feature (#1279)
docs: Upgrade docus (3adf4e5)
use-content-head: Add helper for <head> binding (#1295)
document-driven: Add caching layer on client-side (#1312)
Add web-types.json for WebStorm (#1288)
Support navigation field in content and _dir.yml (#1328)
Disable document driven with route meta (#1333)
tailwindcss: Support tailwindcss classes in content (with hmr) (#1351)
Improve where query types (#1359)
Export transformers (#1374)
DocumentDriven configuration (#1378)
<markdown>: Support fallback default slot (#1405)
Create index for path base search (#1401)
Pre fetch contents on build (#1411)
Per-page components (#1429)
Implement csv parser with unist/mircomark stack (#1468)
generate: Use nitro header instead of header link (#1502)

🩹 Fixes

navigation: Allow navigation opt-out with navigation: false (#1208)
types: More accurately represent ParsedContentMeta (#1196)
types: Change QueryBuilderParams keys to partial (#1203)
ContentQuery: Handle null data (#1230)
markdown: Issue with h1-6 tags (#1223)
markdown: Detect inline component followed non whitespace characters (#1227)
query: Use exact match for findOne (#1224)
query: Surround and only cannot be used at the same time (#1238)
storage: Warn & ignore files with invalid characters (#1239)
lint: Fix linting (ellipsis.vue) (855bb38)
ContentQuery: Add condition if value is undefined (6a05508)
mdc-parser: Minor fixes in markdown generation (caf9b83)
highlight: Preload common languages (#1278)
query: Handle array fields in $in operator (#1277)
document-driven: Update documentDriven feature (#1294)
highlight: Warn about languages dynamic loading (#1291)
markdown: Generate depth field in TOC for h5 & h6 (#1296)
Support layout from defined vue page in DDM (48fc30b)
ignore: Fix ignore paths injected from the module (97f1d74)
runtime: ContentRenderer extra props (#1300)
Remove _theme.yml fetch with doc driven by default (#1310)
ContentRendererMarkdown: Preload components used in content (#1309)
markdown: Attributes of span inside headings (#1307)
Handler files with index as substring (#1334)
document-driven: Rendering flash (#1336)
DocumentDrivenNotFound shall use the layout (d41205a)
highlight: Remove @nuxt/kit from runtime bundle (#1346)
document-driven: Add empty promise for disabled features (#1356)
hot: Mitigate empty code blocks (hotfix) (a13cca9)
lint: Fix linting (cbf08ad)
highlight: Respect highlight option (#1372)
Clone head.meta before manipulating (#1370)
prose-components: Use html anchor link in headings (#1381)
Support components/content in layers for extends (#1404)
document-driven: Throw 404 error when content is missing (#1394)
Import useRoute (#1408)
document-driven: Only set 404 status on SSR (#1409)
query: Do not create empty where (c71c79b)
content-index: Files in content directory has higher priority (#1414)
markdown: Add missing task list class (#1416)
Make sure components/content is on top in layers (#1418)
Remove (now deprecated) template utils (#1423)
pre-fetch: Support github driver (#1433)
query: Ensure where is set (10709ee)
json: Handle parsed content (#1437)
Avoid mutating _layers (#1455)
prerender: Add extension to pre-rendered queries (#1456)
<ContentRenderer>: Prioritize default slot (#1460)
useContentHead was not respecting og:image props (#1461)
document-driven: Avoid calling middleware on hash change (5a64f46)
runtime: Allow to give instance of the remark plugin (#1466)
useContentHead: Set title only if defined (9b9b648)
module: Do not add vue files to ignore list (#1476)
<MarkDown>: Prevent multiple deprecation log (#1497)

💅 Refactors

⚠️ Spell extensions correctly (#1204)
Use remark-mdc package (#1315)
Extract nitro logic from transformers (#1352)

📖 Documentation

Fix typo (fff00b1)
Remove config redirect (04fe424)
Upgrade with latest docus (#1250)
Update playground (96c161d)
Update driverOptions (7adaed1)
Note about rendering content in Get Started (#1255)
Small typo (1b7fd92)
get-started: Minor fixes (#1274)
Add edge releases channel (58cae1d)
edge-channel: Update edge package name (fe1ebb5)
Upgrade @nuxt/content (3dc1f25)
Update document-driven page (90d04bb)
Move example of doc driven (6426160)
Improve examples (#1302)
Fix inline code block (#1303)
Fix missing slash (#1306)
Generate blog too (#1311)
Fix link to document-driven example (6e1ff3b)
Add template for doc-driven mode (a4ab944)
Fix the link-id for the surround EN v1 docs (#1321)
Missing , (#1330)
Specify version in v1 installation guide (85e22ac)
Remove doubled . from filename (docs FR v1) (#1323)
Add edge channel for document-driven mode (4b23370)
Improve catch-all section in document-driven mode (93813f9)
Fix typo (e82fed4)
sitemap: Add npm and pnpm install script (#1349)
Add deploy section (#1347)
api: QueryContent().sort() descending sorting (#1364)
Add article 'a' to sentence (#1395)
Move fetchContentNavigation into function (#1403)
Upgrade deps (#1424)
Upgrade deps " (#1424)
Fix typo 'Convent' -> 'Content' (#1442)
Describe highlight.preload (#1436)
Add pnpm as project start option (#1450)
Excerpt (#1441)
Document transformers (#1453)
Temporary use <Markdown> (ac95d13)
README: Fix link to MDC syntax (#1467)
querying: Add _params to api routes (#1463)
Playground content from query (#1499)
Upgrade docus (#1503)
Update home page (d7bd2b1)
Update social image (8cdae3e)

🏡 Chore

Typo (fd1c56d)
docs: Upgrade docs (d0ee386)
prepare: Prepare for 2.1.0 release (update version) (3dd85b5)
playground: Add example with ddm and vue page (07d7988)
Remove style and rename document-driven class (8bf9154)
Add page:content:start hook (45f696b)
Rename to content:middleware:start (63749d2)
Remove unctx from dependencies (#1413)
Deprecate markdown component (#1435)
Upgrade to nuxt rc9 (#1498)
Use latest docus (ef5c3ec)

⚠️ Breaking Changes

⚠️ Spell extensions correctly (#1204)

❤️ Contributors

Ahad Birang
Alexey Tuzov
Benjamin Canac
Clément Ollivier
Daniel Roe
Farnabaz
Gregor Becker
Gustavo Alfredo Marín Sáez
Harlan Wilton
Itshizhan
Kot
Kotaro Yabe
Lukas Von Blarer
Maciej Błędkowski
Nobkd
Pooya Parsa
Rem
Sébastien Chopin
Vinayak Kulkarni
Vinccool96
Yaël Guilloux

v2.0.1 by TahulMay 31, 2022

Important notes

Since #1176, we've modified the descending sorting behavior to be -1 instead of 0 to stick with Mongo sort syntax.

- queryContent('/my-directory').sort({ createdAt: 0 })
+ queryContent('/my-directory').sort({ createdAt: -1 })

Features

We added content:file:beforeParse and content:file:afterParse hooks to manipulate the data before and after its transformation, you can read more in the advanced section of the documentation. PR #1160 by @farnabaz

Fixes

fix: ContentQuery _path not used properly (#1141) by @GerryWilko in #1143
fix(frontmatter): issue with windows carriage return by @farnabaz in #1161
fix: typo that->than, highlight span to improve comprehension by @TheJoeSchr in #1163
fix(ContentQuery): generate cache key based on props by @farnabaz in #1174
fix(sort): use -1 for descending same as mongo syntax by @farnabaz in #1176
fix(navigation): do not nest home page by @farnabaz in #1179
fix(sort): convert Date to ISO string by @farnabaz in #1175
fix(types): _title rename to title by @cawa-93 in #1181
fix(query): escape special chars in path by @farnabaz in #1185

Docs

docs: Update 1.query-content.md by @jhull in #1138
docs: correct spelling of ContentDoc by @nobkd in #1144
docs: fix template name by @manniL in #1147
docs: correctly link to catch-all documentation by @loilo in #1148
docs: content comment is now link to option docs by @ravenberg in #1150
docs: typo by @seanghay in #1158
docs: added information on sitemap generation by @heychazza in #1145
docs: typo Rendering Doc by @king-11 in #1162
docs: add --shamefully-hoist argument to pnpm install by @Julien-R44 in #1159
docs: fix querying example route is not defined by @Jclong98 in #1166
docs: correct path of ContentRenderer source code by @sudhakar-s in #1165
docs(redirects): remove configuration redirect by @clemcode in #1183
docs:fixing navigation comments re: default value by @MichaelJolley in #1182

Misc

chore(deps): update devdependency lint-staged to ^12.4.3 by @renovate in #1173
chore(deps): update all non-major dependencies by @renovate in #1134
chore(deps): lock file maintenance by @renovate in #1172
chore(deps): update devdependency lint-staged to ^12.5.0 by @renovate in #1186