{"id":15297062,"url":"https://github.com/wilsson/papyrum","last_synced_at":"2025-04-13T22:32:15.208Z","repository":{"id":49362057,"uuid":"170594731","full_name":"wilsson/papyrum","owner":"wilsson","description":"Papyrum is a tool that will help you in the creation of your design system, style guide or in the documentation of your project based on react","archived":false,"fork":false,"pushed_at":"2023-10-19T15:22:06.000Z","size":1254,"stargazers_count":20,"open_issues_count":2,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-31T23:31:24.323Z","etag":null,"topics":["design-systems","docs","documentation","react","styleguide","ui","zero-configuration"],"latest_commit_sha":null,"homepage":"https://papyrum.site/","language":"TypeScript","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/wilsson.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-13T23:22:12.000Z","updated_at":"2023-03-08T18:18:02.000Z","dependencies_parsed_at":"2024-06-19T06:11:50.421Z","dependency_job_id":"d09a3969-d6c9-4076-9b67-753b7b1cf988","html_url":"https://github.com/wilsson/papyrum","commit_stats":{"total_commits":185,"total_committers":5,"mean_commits":37.0,"dds":"0.14054054054054055","last_synced_commit":"dbfe196bea2c5a99d590eb08a50416b46f9c7d98"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsson%2Fpapyrum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsson%2Fpapyrum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsson%2Fpapyrum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wilsson%2Fpapyrum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wilsson","download_url":"https://codeload.github.com/wilsson/papyrum/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223607919,"owners_count":17172828,"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":["design-systems","docs","documentation","react","styleguide","ui","zero-configuration"],"created_at":"2024-09-30T19:14:56.174Z","updated_at":"2024-11-08T00:03:36.288Z","avatar_url":"https://github.com/wilsson.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/4754339/71502967-1a73bf80-2841-11ea-9add-13cd5bd905dd.png\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@papyrum/cli\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/v/@papyrum/cli\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@papyrum/cli\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/dt/@papyrum/cli\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"LICENSE\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/license/@papyrum/cli\" alt=\"\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n[Papyrum](https://papyrum.site/) is a tool that will help you document your design system or library of components based on [React](https://reactjs.org/).\n\n## Features\n\n- Zero config\n- [MDX based](https://mdxjs.com/), builds documentation with the markdown of the component era.\n- Typescript support\n- Syntax highlighting with [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer).\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/4754339/91013125-d80ba980-e5ac-11ea-805d-0361ece616cd.png\" /\u003e\n\u003c/p\u003e\n\n## Start a new project\n\nPapyrum brings with it a command that will help you build your project based on templates.\n\n```bash\nnpx @papyrum/cli new [name] [template]\n```\n\nFor example:\n\n```bash\nnpx @papyrum/cli new my-website basic\n\n```\n\n| Template | Description |\n| ------------- | ------------- |\n| `basic` | Basic template |\n| `typescript` | Basic template with typescript |\n\n### Project structure\n\n```\nmy-website\n├── docs\n│   ├── Introduction.mdx\n│   └── Button.mdx\n├── src\n│   └── components\n├── static\n│   └── img\n│       ├── favicon.ico\n│       └── logo.svg\n├── package.json\n├── .editorconfig\n├── papyrum.config.js\n└── yarn.lock\n```\n\n### Structure summary\n\n- `docs` : Folder where our `.mdx` documentation files are hosted.\n- `src` : Ffolder where the components to be built are stored, in the case of building a component library.\n- `static` : Default place where static files will be served.\n- `papyrum.config.js` : Papyrum settings.\n\nNow execute this command to be able to raise a development server that will listen to your changes as you develop.\n\n```\nyarn dev\n```\n\nor\n\n```\nnpm run dev\n```\n\n## Add Papyrum to an existing project\n\nYou just need to install the command line tool:\n\n```\nyarn add @papyrum/cli\n```\n\nor\n\n```\nnpm install @papyrum/cli\n```\n\nThen create an `.mdx` file:\n\n```\n---\nroute: /\nname: Hello world\n---\n\n# Hi!\n___\n\nHello world with mdx\n```\n\nFinally run:\n\n```\nyarn dev\n```\n\nor\n\n```\nnpm run dev\n```\n\n## Examples\n\n- [Basic](https://github.com/wilsson/papyrum/tree/master/examples/basic)\n- [With typescript](https://github.com/wilsson/papyrum/tree/master/examples/typescript)\n\nIf you have any suggestion of a feature or feedback please do not hesitate to create a [issue](https://github.com/wilsson/papyrum/issues).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilsson%2Fpapyrum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwilsson%2Fpapyrum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwilsson%2Fpapyrum/lists"}