{"id":22410431,"url":"https://github.com/richmd/richmd","last_synced_at":"2025-07-31T21:31:03.383Z","repository":{"id":42030103,"uuid":"323246091","full_name":"bebeji-nappa/richmd","owner":"bebeji-nappa","description":"Richmd expand basic Markdown syntax to customaize it.","archived":false,"fork":false,"pushed_at":"2024-10-07T21:15:28.000Z","size":44344,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-01T12:50:24.263Z","etag":null,"topics":["codeblocks","front-end","html","katex","markdown","math","richmd","typescript"],"latest_commit_sha":null,"homepage":"","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/bebeji-nappa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-12-21T06:06:10.000Z","updated_at":"2024-11-12T08:44:08.000Z","dependencies_parsed_at":"2024-02-22T13:53:25.346Z","dependency_job_id":null,"html_url":"https://github.com/bebeji-nappa/richmd","commit_stats":{"total_commits":121,"total_committers":1,"mean_commits":121.0,"dds":0.0,"last_synced_commit":"f892c401e004228e2dd59ad1225a846830ec1256"},"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bebeji-nappa%2Frichmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bebeji-nappa%2Frichmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bebeji-nappa%2Frichmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bebeji-nappa%2Frichmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bebeji-nappa","download_url":"https://codeload.github.com/bebeji-nappa/richmd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228304112,"owners_count":17898919,"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":["codeblocks","front-end","html","katex","markdown","math","richmd","typescript"],"created_at":"2024-12-05T13:09:08.667Z","updated_at":"2025-07-31T21:31:03.363Z","avatar_url":"https://github.com/bebeji-nappa.png","language":"TypeScript","readme":"# Richmd (Legacy package)\n![NPM](https://img.shields.io/npm/l/richmd)\n![npm](https://img.shields.io/npm/v/richmd)\n![npm](https://img.shields.io/npm/dw/richmd)\n\n\n# WARNING: `richmd` is now in maintenance mode.\n\nWith the release of the latest Richmd v3, this package has entered maintenance mode.\n\nMigration is simple and straightforward.\n\n## Migrating from v2 to v3\n\nInstall `@richmd/js`:\n\n```sh\n$ pnpm add @richmd/js\n```\n\nUpdate your imports as follows:\n\n```diff\n-import { richmd } from 'richmd'\n-import 'richmd/richmd.css'\n+import { richmd } from '@richmd/js'\n+import \"@richmd/js/dist/richmd.css\";\n```\n\n## Upcoming Schedule\n\n- From **2025/03/23**: All methods in this package will be deprecated and development will end.\n- By **June 2025**: This repository will be archived and the npm package will be marked as deprecated.\n\n\n## What is Richmd?\nRichmd is a tool for making Rich contents Markdown language.\n\n![Richmd](./docs/images/preview.png)\n\n## Installation\n\n```bash\n# use npm\n$ npm install richmd\n\n# use yarn\n$ yarn add richmd\n```\n\n## Usage\n- [Usage for React](./docs/usage-react.md)\n- [Usage for Vue](./docs/usage-vue.md)\n- [Usage Webpack](./docs/Setup-webpack.md)\n\n### Retrieve Abstract Syntax Tree (AST) Data\nYou can retrieve Abstract Syntax Tree (AST) data using the `parseTree` method.\nThis is useful for customizing code generation on your own.\n\n```js\nimport { parseTree } from 'richmd';\n\nconst text = `# aaaa\n## aaaaa\n\n**aaaaaa**\n`\n\nconst ast = parseTree(text);\n```\n\n\n## Markdown Syntax\nPlease read [Richmd Markdown Syntax Documentation](./docs/md-syntax.md).\n\n### Supported Syntax\n- strong\n- italic\n- image\n- link\n- headings\n- horizontal rule\n- blockquote\n- unordeed list\n- ordered list\n- strikethrough\n- code block\n- checkbox list\n- table\n- TeX syntax (using [KaTeX](https://katex.org/))\n- Color Inline Block\n- Dropdown details\n- Video(HTML5 Video Tag)\n- Custom HTML Tag\n\n## License\nMIT\n\n## Thank you :pray:\n- [Markdown-tree-parser](https://github.com/ysugimoto/markdown-tree-parser)\n  - Richmd's Markdown parser was created using the code in markdown-tree-parser as a reference.\n- [KaTeX](https://github.com/KaTeX/KaTeX)\n- [highlight.js](https://github.com/highlightjs/highlight.js/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichmd%2Frichmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichmd%2Frichmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichmd%2Frichmd/lists"}