{"id":22432531,"url":"https://github.com/zhusiqing/api-document","last_synced_at":"2025-03-27T07:42:26.801Z","repository":{"id":109060515,"uuid":"324112421","full_name":"zhusiqing/api-document","owner":"zhusiqing","description":"api is displayed by markdown, and visually input data，and Developing...","archived":false,"fork":false,"pushed_at":"2021-02-04T07:58:28.000Z","size":536,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T12:45:40.697Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhusiqing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2020-12-24T09:00:11.000Z","updated_at":"2021-02-04T07:58:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"ffe8969d-8a14-4498-a18f-420a251126a1","html_url":"https://github.com/zhusiqing/api-document","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Fapi-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Fapi-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Fapi-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhusiqing%2Fapi-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhusiqing","download_url":"https://codeload.github.com/zhusiqing/api-document/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245806022,"owners_count":20675291,"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":[],"created_at":"2024-12-05T22:12:04.056Z","updated_at":"2025-03-27T07:42:26.783Z","avatar_url":"https://github.com/zhusiqing.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"100\"src=\"https://raw.githubusercontent.com/nicejade/arya-jarvis/master/assets/images/logo.png\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e文档\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cstrong\u003e\n    支持多种编辑markdown的方式，最后生成文档\n  \u003c/strong\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://nodejs.org/en/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/node-%3E%3D%2012.0.0-green.svg\" alt=\"Node Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://nicelinks.site/post/5c16083e819ae45de1453caa\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat\" alt=\"Prettier\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## 目标与哲学\n\n每次与后端进行接口文档协商，最后输出的接口文档总会有部分写的不清楚或者懒得写一些要求，于是打算通过表单的形式来限制一下。\n因为工作的原因一直使用vue进行开发，但是本人想用react进行一些开发，所以这里使用react+typescript开发也是为了学习和实践。\n\n## 先决条件\n\n您需要安装或升级 [Node.js](https://nodejs.org/en/)（\u003e = `12。* `，[Yarn](https://www.jeffjade.com/2017/12/30/135-npm-vs-yarn-detial-memo/) 作为首选）。\n\n## 安装\n\n```bash\nyarn\n# 如果你没有yarn\nnpm i\n```\n\n## 开发\n\n```bash\nyarn start\n# 如果你没有yarn\nnpm run start\n```\n\n## 构建\n\n```bash\nyarn build\n# 如果你没有yarn\nnpm run build\n```\n\n## 屏幕截图\n\n暂无\n\n## 支持\n\n告诉人们他们可以去哪里寻求帮助。它可以是 issue 跟踪器，聊天室，电子邮件地址等的任意组合。\n\n## 路线图\n\n- [ ] 先用基础的库做出并完善一个简易的文档功能\n- [ ] 采用一些额外的库进行优化\n- [ ] 目前使用的后台服务是自己简单搭建的，不适合公开，后面优化同时去掉一些敏感数据再进行公开\n\n## 执照\n\n[MIT](http://opensource.org/licenses/MIT)\n\n版权所有 (c) 2021-至今，[zhusiqing](https://zsqlm.cn)。\n\n## 项目状态\n\n开发中\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhusiqing%2Fapi-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhusiqing%2Fapi-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhusiqing%2Fapi-document/lists"}