\n\n> A library named Markdown CMS for markdown rendering with markdown cms for editing\n\n### 🏠 [Homepage](https://github.com/linwaiwai/markdown-cms)\n\n### ✨ [Demo](http://www.openapplus.com/docs/introduce)\n\n## Prerequisites\n\n- node >=8.0.0\n\n## Install\n\n```sh\n* npm install --save @openapplus/markdown-cms\n```\n\n## Usage\n\nThe demo below use umi framework refer https://umijs.org\n\n### article component \n\n```javascript\nimport React, { Component } from 'react';\nimport PropTypes from 'prop-types';\nimport { MainContent } from '@openapplus/markdown-cms';\nimport { connect } from 'dva';\n@connect(({ article }) => ({\n localizedPageData: article.localizedPageData,\n menuItems: article.menuItems,\n pathname:article.pathname,\n}))\nexport default class Article extends MainContent {\n\n componentWillMount() {\n const {\n location: {\n pathname\n },\n dispatch\n } = this.props;\n dispatch({\n type: \"article/fetchInit\",\n payload: { pathname: pathname.replace('/article/','') },\n });\n }\n\n}\n```\n\n### article model \n\n```javascript\nimport { message } from 'antd';\nimport router from 'umi/router';\nimport { Render } from '@openapplus/markdown-cms';\n\nexport default {\n namespace: \"article\",\n state: {\n localizedPageData: {\n meta:{\n title:\"\",\n subtitle:\"\",\n filename:\"\"\n },\n toc:null\n },\n menuItems: [],\n pathname:\"\"\n },\n effects: {\n *fetchInit({ payload: { pathname } }, { call, put }) {\n const pageDataPath = pathname.split('/');\n const responseMenu = yield call(Render.getMenuItem, pageDataPath[0]);\n const responseData = yield call(Render.getPageData, pathname);\n if (responseMenu\n && responseData\n ) {\n yield put({\n type: 'saveInit',\n payload: {\n localizedPageData: responseData,\n menuItems: responseMenu,\n pathname:pathname\n },\n });\n }\n },\n },\n reducers: {\n saveInit(state, {payload}) {\n return {\n ...state,\n ...payload,\n };\n }\n },\n}\n```\n* need the complete demo, just click the link https://github.com/linwaiwai/markdown-cms, and read the license note\n\n* markdown-cms render offer a way to modify Link Component for you to adapt some framework\n\n```javascript\nimport { Link } from 'react-router';\nimport {Render, Config} from '@openapplus/markdown-cms';\nConfig.setConfigByKey('components', {\n Link:Link\n });\n```\n\n* configure the request url\n\n```javascript\nimport {Render, Config} from '@openapplus/markdown-cms';\nConfig.setConfigByKey(\"detailURL\",\"/api/cms/content/detail\");\nConfig.setConfigByKey(\"menuItemsURL\",\"/api/cms/content/menuItems\");\n```\n\n* the request repsonse format\n\napi: /api/cms/content/menuItems?fullName=docs\nrepsonse:\n```Json\n{\"code\":200,\"success\":true,\"data\":[{\"title\":\"介绍\",\"filename\":\"/docs/introduce.md\",\"type\":\"file\",\"children\":null},{\"title\":\"小程序框架\",\"filename\":null,\"type\":\"category\",\"children\":[{\"title\":\"小程序框架\",\"filename\":\"/docs/framework/overview.md\",\"type\":\"file\",\"children\":null}]}],\"msg\":\"操作成功\"}\n```\n\napi: /api/cms/content/detail?filename=docs%2Fdownload.md\nrepsonse:\n```Json\n{\"code\":200,\"success\":true,\"data\":{\"id\":\"1278994423081050113\",\"createUser\":null,\"createDept\":null,\"createTime\":\"2020-07-03 10:10:08\",\"updateUser\":null,\"updateTime\":\"2020-07-03 10:10:08\",\"status\":1,\"isDeleted\":0,\"tenantId\":\"000000\",\"title\":\"介绍\",\"content\":\"---\\norder: 0\\ntitle: \\n zh-CN: 介绍\\n en-US: 介绍\\n---\\n\\n\\n\\n# 概述\\n\\nOpenApp+ 一个小程序容器，配置简单、功能完善、界面流畅、开箱即用！使用OpenApp+可以快速扩展你的APP，使其拥有与微信一样的功能扩展可能，让App的所有的功能都通过小程序来实现，动态更新，更快的响应用户需求。其拥有的管理具备版本管理功能，让功能发布更加随心。\\n\\n## 谁在使用\\n\\n如果你和你的组织使用了这个产品，欢迎到 [Github](https://github.com/linwaiwai/openapplus/issues/3) 留言。\\n\\n\\n### For 开发者\\n\\n如果你是工程师，请详细阅读开发文档，具体介绍请查看 [使用文档](/docs/introduction)。\\n\\n\\n## 如何贡献\\n\\n我们欢迎任何形式的贡献，有任何建议或意见，请给我们 [提问]()。\\n\",\"filename\":\"introduce\",\"categoryId\":\"1278\",\"categoryName\":\"文档\"},\"msg\":\"操作成功\"}\n```\n\n## Markdown template\n\n```\n---\norder: 4\ntitle: \n zh-CN: 资源下载\n en-US: 资源下载\n---\nOpenApplus将为专业版本以上客户提供的自定义API功能的。提供的自定义API功能的能够在IDE上编写mock接口，在客户端环境调用本地API。\n\n使用的协议为：\nwx.api.setNavigationBarTitle({title:\"hello\", success:function(){}, fail:function(){}});\n\n```\n\n## Run tests\n\n```sh\nyarn run test\n```\n\n## License\n\n/*\n * GPLv3 License\n *\n * A library named Markdown CMS for markdown rendering with markdown cms for editing\n *\n * Copyright (C) 2020 linwaiwai(jiansihun@foxmail.com)\n * \n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n * \n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n * \n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n * \n * Note:\n * \n * This library is using opensource license GPLv3.\n * \n * If your want to have it for commerce use, please contract author to be granted. \n * \n * All the income will be donated to support the work of doctor at Wuhan Province in China until the epidemic of Wuhan ends.\n * \n * Commerce authorization package will include frontend and backend solution, in which The frontend solution includes Markdown reader component and a micro frontend service which contains admin tools for json configuration, the backend is a SDK tool based on the SpringBoot.\n * \n * All this will cost you only 500 yuan/year for public welfare. What a good deal.\n * \n * Demo Link: http://www.openapplus.com/docs/introduce\n * \n * 如果您想使用该库作为商业用途，需要联系作者（jiansihun@foxmail.com）进行授权。\n * \n * 所有的收入将会被捐献给武汉抗疫直至疫情结束。\n * \n * 商业授权包含前后端的解决方案，即包含Markdown Render组件以及后台配置界面。后端代码基于Spring Boot。\n * \n * 每年授权费用500元人民币用于公益用途，十分划算。\n * \n * 前端演示地址: http://www.openapplus.com/docs/introduce\n *\n */\n\n## Author\n\n👤 **linwaiwai**\n\n* Website: http://www.openapplus.com\n* Twitter: [@linwaiwai](https://twitter.com/linwaiwai)\n* Github: [@linwaiwai](https://github.com/linwaiwai)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/linwaiwai/autochart/issues). \n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n***\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_","readmeFilename":"README.md"}
![\"Version\"](\"https://img.shields.io/badge/version-1.2.8-blue.svg?cacheSeconds=2592000\"){kind=icon}
\n ![](\"https://img.shields.io/badge/node-%3E%3D8.0.0-blue.svg\"){kind=icon}
\n \n ![\"Documentation\"](\"https://img.shields.io/badge/documentation-yes-brightgreen.svg\"){kind=icon}
\n \n \n ![\"License:](\"https://img.shields.io/badge/License-GPL--3.0-yellow.svg\"){kind=icon}
\n \n \n ![\"Twitter:](\"https://img.shields.io/twitter/follow/linwaiwai.svg?style=social\")
\n \n