Giter VIP home page Giter VIP logo

mdx-paper's Introduction

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 Vercel either connect the Vercel for GitHub application or run vercel locally.

Examples

mdx-paper's People

Contributors

hubgit avatar

Stargazers

 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

mdx-paper's Issues

Auto-generate numbered labels

For figures and tables - or, in fact, any object that requests them - generate numbered labels.

Set the contents of the label and the contents of any cross-references to the labelled object.

Repo doesn't have a license

I noticed the repo doesn't have a license.

Would this repo ever be MIT or GPL licensed?

It seems like a cool project.

Other folks wouldn't really be able to contribute if the project doesn't have a license.

Edit: I noticed the package.json has this line: "license": "MIT",.

I'm going to fork the repo, but I'll make sure to attribute the project to your account.

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.