Git Product home page Git Product logo

mdx-module's Introduction

@nuxtjs/mdx

@nuxtjs/mdx

npm version npm downloads Github Actions CI Codecov License

MDX module for Nuxt 2

Features

  • Import .mdx files as Vue components
  • Import Vue components in your .mdx files
  • Replace markdown elements with Vue components with the MDX Provider.

Development

  1. Clone this repository
  2. Install dependencies using yarn
  3. Start development server using yarn dev

License

MIT License

Copyright (c) Nuxt Community

mdx-module's People

Contributors

allcontributors[bot] avatar atinux avatar codebender828 avatar dominikangerer avatar dominuskelvin avatar harlan-zw avatar pi0 avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

mdx-module's Issues

Reading YAML frontmatter in .mdx files

Hello!

I hope this is the right forum and format to ask this question in. I'm currently building a Nuxt blog and making use of the @nuxtjs/mdx module. Everything is working fine except for my front matter block I have in one of my test blog posts. When it renders in the browser, it appears as elements (h1 and p) on the page when I know it shouldn't be and should be used as metadata.

I was wondering if there was an established way of handling something like YAML in .mdx files? I've found plugins out in the wild but for gatsby, and nothing specifically for Nuxt.

Any and all assistance/guidance would be very much appreciated! :D

[docs] leverage components module

We may benefit from nuxt components to avoid manually importing mdx files. Since it inherits additionalExtensions i think should work out of the box here

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

  • WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/ci.yml
  • actions/setup-node v1
  • actions/cache v2
  • codecov/codecov-action v1
npm
docs/package.json
  • @nuxt/content-theme-docs ^0.8.2
  • nuxt ^2.14.11
  • nuxt-ackee ^2.0.0
package.json
  • babel-loader ^8.2.2
  • @changesets/cli ^2.12.0
  • @vue/babel-preset-jsx ^1.2.4

  • Check this box to trigger a request for Renovate to run again on this repository

Nuxtjs: npm install postinall throws error

Describe the bug
npm install --save-dev @nuxtjs/mdx throws error "postinstall": "yarn --cwd docs" spawn ENOENT,
Failed at the @nuxtjs/[email protected] postinstall script.

To Reproduce
Steps to reproduce the behavior:

  1. Within Nuxt.js project
  2. Run npm install --save-dev @nuxtjs/mdx
  3. See error: postinstall": "yarn --cwd docs" spawn ENOENT

Expected behavior
npm package is installed successfully.

Desktop (please complete the following information):

  • OS: macOS Catalina
  • npm version: 6.14.9
  • node version: v14.15.3

Do I really need yarn to use this package?
Any help would be appreciated! Thanks!

"yarn add" error spawn E2BIG

Describe the bug
@nuxtjs/mdx does not install via yarn

To Reproduce
Steps to reproduce the behavior:

  1. Go to your project in terminal.
  2. type 'yarn add --dev @nuxtjs/mdx' and press enter
  3. wait.
  4. See error

Expected behavior
module to install without error.

Screenshots
none.

Desktop (please complete the following information):

  • OS: darwin x64
  • Browser [e.g. chrome, safari]
  • Version catalina

Additional context
yarn-error.log
Arguments:
/Users/*****/.nvm/versions/node/v12.18.4/bin/node /usr/local/Cellar/yarn/1.22.10/libexec/bin/yarn.js --cwd docs

PATH:
...

Yarn version:
1.22.10

Node version:
12.18.4

Platform:
darwin x64

Trace:
Error: spawn E2BIG
at ChildProcess.spawn (internal/child_process.js:407:11)
at Object.spawn (child_process.js:548:9)
at /usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:25829:24
at new Promise ()
at new F (/usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:5301:28)
at /usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:25828:12
at run (/usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:43133:7)
at BlockingQueue.maybePushConcurrencyQueue (/usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:43148:7)
at BlockingQueue.shift (/usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:43143:10)
at /usr/local/Cellar/yarn/1.22.10/libexec/lib/cli.js:43087:15

package.json
"dependencies": {
"@nuxt/content": "^1.9.0",
"@nuxt/content-theme-docs": "^0.6.0",
"@nuxt/types": "^2.14.6",
"@nuxtjs/color-mode": "^1.1.1",
"@nuxtjs/google-fonts": "^1.0.3",
"@nuxtjs/pwa": "^3.0.2",
"@nuxtjs/tailwindcss": "^3.1.0",
"@tailwindcss/typography": "^0.2.0",
"axios": "^0.20.0",
"clipboard": "^2.0.6",
"defu": "^3.1.0",
"lodash.groupby": "^4.6.0",
"lodash.sortby": "^4.7.0",
"marked": "^1.2.0",
"nuxt": "^2.14.6",
"nuxt-i18n": "^6.15.1",
"postcss-import": "^12.0.1",
"postcss-preset-env": "^6.7.0",
"postcss-selector-parser": "^6.0.4",
"prism-themes": "^1.4.0",
"vue-scrollactive": "^0.9.3"
}

Why isn't the version updated

I have a lot of expectation for these MDX-modules, and I will use these libraries in the future. Why haven't the versions been updated?

Support Nuxt 3

Hey 👋 It looks like this module hasn't been updated for Nuxt 3. In an effort to improve the developer experience of modules, I've updated the module to clarify that it only supports Nuxt 2.

If Nuxt 3 support is added it will be moved to the https://github.com/nuxt-modules organisation.

@codebender828 Is Nuxt 3 support something you have planned? If not, perhaps we can archive this module?

Please let us know and thanks for your work!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.