{"id":17970296,"url":"https://github.com/hubgit/mdx-paper","last_synced_at":"2025-06-30T00:33:27.296Z","repository":{"id":57293725,"uuid":"181091981","full_name":"hubgit/mdx-paper","owner":"hubgit","description":"React components and webpack configuration for writing an article with MDX","archived":false,"fork":false,"pushed_at":"2023-01-16T09:15:28.000Z","size":154,"stargazers_count":23,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-28T00:46:00.308Z","etag":null,"topics":["citeproc-js","mdx"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mdx-paper","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hubgit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-12T22:32:47.000Z","updated_at":"2024-12-11T10:23:20.000Z","dependencies_parsed_at":"2023-02-10T02:16:03.122Z","dependency_job_id":null,"html_url":"https://github.com/hubgit/mdx-paper","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/hubgit/mdx-paper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hubgit%2Fmdx-paper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hubgit%2Fmdx-paper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hubgit%2Fmdx-paper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hubgit%2Fmdx-paper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hubgit","download_url":"https://codeload.github.com/hubgit/mdx-paper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hubgit%2Fmdx-paper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262689659,"owners_count":23349134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["citeproc-js","mdx"],"created_at":"2024-10-29T15:04:44.914Z","updated_at":"2025-06-30T00:33:27.260Z","avatar_url":"https://github.com/hubgit.png","language":"JavaScript","readme":"# mdx-paper\n\nWrite an article using Markdown and React components ([MDX](https://mdxjs.com/)).\n\n## Install\n\n```sh\nnpm install mdx-paper\n```\n\n## Usage\n\n1. Write your article in `article.mdx`.\n1. Import React components from `mdx-paper` or elsewhere.\n1. Add the article's metadata to `metadata.yml`.\n1. Run `npx mdx-paper` to start a web server and view the article.\n1. Run `npx mdx-paper build` to build the article for deployment, in the `dist` folder.\n\n### References\n\n1. Add a references file as either BibTex, CiteProc JSON or CiteProc YML and use e.g. `--references references.bib` to specify the path.\n1. Specify a [CSL citation style](https://citationstyles.org/authors/) with `--citation-style`, e.g. `--citation-style nature`.\n1. Use `import { Bibliography } from 'mdx-paper'` and place `\u003cBibliography/\u003e` where you'd like the reference list to appear.\n\n### Publishing\n\n1. 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.\n\n\n## Examples\n\n* [A simple example](https://github.com/hubgit/mdx-paper-example)\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhubgit%2Fmdx-paper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhubgit%2Fmdx-paper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhubgit%2Fmdx-paper/lists"}