https://github.com/hubgit/mdx-paper

React components and webpack configuration for writing an article with MDX
https://github.com/hubgit/mdx-paper

citeproc-js mdx

Last synced: about 2 months ago
JSON representation

React components and webpack configuration for writing an article with MDX

• Host: GitHub
• URL: https://github.com/hubgit/mdx-paper
• Owner: hubgit
• License: mit
• Created: 2019-04-12T22:32:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-16T09:15:28.000Z (almost 2 years ago)
• Last Synced: 2024-09-14T03:49:41.736Z (4 months ago)
• Topics: citeproc-js, mdx
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/mdx-paper
• Size: 150 KB
• Stars: 22
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdx-paper

Write an article using Markdown and React components ([MDX](https://mdxjs.com/)).

## Install

```sh

npm install mdx-paper

```

## Usage

1. Write your article in `article.mdx`.

1. Import React components from `mdx-paper` or elsewhere.

1. Add the article's metadata to `metadata.yml`.

1. Run `npx mdx-paper` to start a web server and view the article.

1. 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.

1. Specify a [CSL citation style](https://citationstyles.org/authors/) with `--citation-style`, e.g. `--citation-style nature`.

1. Use `import { Bibliography } from 'mdx-paper'` and place `` where you'd like the reference list to appear.

### Publishing

1. To automatically build and deploy the article to [Vercel](https://vercel.com/) either connect the [Vercel for GitHub](https://vercel.com/github) application or run [`vercel`](https://vercel.com/docs/cli) locally.

## Examples

* [A simple example](https://github.com/hubgit/mdx-paper-example)