mdx-util - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #golang #android #rust #linux #docker #java #cli #kubernetes #pytorch #security #open-source

mdx-util

(★ 709)

Utilities for working with MDX

File Explorer

Download Latest Version (.zip)

- - .babelrc
  - .npmignore
  - package.json
  - README.md
  - yarn.lock
- - index.js
  - package.json
  - README.md
  - test.js
- - index.js
  - package.json
  - README.md
  - typography.js
- - index.js
  - package.json
  - README.md
  - test.js
- - mdx.macro.js
  - package.json
  - README.md
  - test.js
.gitignore
lerna.json
LICENSE.md
package.json
README.md
TODO.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/frontarm/mdx-util

Downloads the entire project code from GitHub to your computer.

cd mdx-util

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd deprecated-packages/mdxc

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

mdx-util
========

**A collection of utilities for working with MDX**

-   [mdx-constant](./packages/mdx-constant)

Exports a constant from MDX files that don't explicitly define it. Useful for implementing front matter with [gray-matter](https://github.com/jonschlinkert/gray-matter).

-   [mdx-loader](./packages/mdx-loader)

A batteries included loader for MDX.

* Emoji support via [remark-emoji](https://www.npmjs.com/package/remark-emoji)
    * Image urls are automatically embedded as images via [remark-images](https://www.npmjs.com/package/remark-images)
    * All headings have `id` slugs added via [remark-slug](https://github.com/remarkjs/remark-slug)
    * Code blocks have markup for syntax highlighting via [prismjs](https://prismjs.com/) and [rehype-prism](https://github.com/mapbox/rehype-prism). *Note: you'll still need to import the prism stylesheet yourself.*
    * Front matter is exported on a `frontMatter` object via [gray-matter](https://github.com/jonschlinkert/gray-matter).
    * A table of contents object is exported on the `tableOfContents` object via [mdx-table-of-contents](./packages/mdx-table-of-contents).

-   [mdx-table-of-contents](./packages/mdx-table-of-contents)

An MDX plugin that exports a `tableOfContents` object, along with the exported component.

-   [mdx.macro](./packages/mdx.macro)

An MDX macro to facilitate usage of MDX with [create-react-app](https://facebook.github.io/create-react-app/), *without* ejecting.