Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
src
 
 
 
 
 
 
 
 

mdx-paper

Write an article using Markdown and React components (MDX).

Install

npm install mdx-paper

Usage

  1. Write your article in article.mdx.
  2. Import React components from mdx-paper or elsewhere.
  3. Add the article's metadata to metadata.yml.
  4. Run npx mdx-paper to start a web server and view the article.
  5. Run npx mdx-paper build to build the article for deployment, in the dist folder.

References

  1. Add a references file as either BibTex, CiteProc JSON or CiteProc YML and use e.g. --references references.bib to specify the path.
  2. Specify a CSL citation style with --citation-style, e.g. --citation-style nature.
  3. Use import { Bibliography } from 'mdx-paper' and place <Bibliography/> where you'd like the reference list to appear.

Publishing

  1. To automatically build and deploy the article to Zeit Now add a now.json file and either connect the Now for GitHub application or run now locally.

Examples

About

React components and webpack configuration for writing an article with MDX

Topics

Resources

Packages

No packages published