{"id":16767839,"url":"https://github.com/eolinker/apinto-docs","last_synced_at":"2025-04-10T19:21:13.237Z","repository":{"id":36982525,"uuid":"473892522","full_name":"eolinker/apinto-docs","owner":"eolinker","description":"Apinto document project, which includes the use tutorials, development documents and other related contents of apinto. ","archived":false,"fork":false,"pushed_at":"2024-09-24T07:39:38.000Z","size":1011,"stargazers_count":5,"open_issues_count":1,"forks_count":10,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-24T17:01:37.386Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://help.apinto.com/docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eolinker.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-25T06:21:45.000Z","updated_at":"2024-09-24T07:39:42.000Z","dependencies_parsed_at":"2025-02-17T21:32:37.075Z","dependency_job_id":"00d64e77-4175-4f4a-b07d-d6657e0a4fca","html_url":"https://github.com/eolinker/apinto-docs","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/eolinker%2Fapinto-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eolinker%2Fapinto-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eolinker%2Fapinto-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eolinker%2Fapinto-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eolinker","download_url":"https://codeload.github.com/eolinker/apinto-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248281382,"owners_count":21077423,"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-10-13T06:10:02.874Z","updated_at":"2025-04-10T19:21:13.196Z","avatar_url":"https://github.com/eolinker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# apinto-docs\nApinto document project, which includes the use tutorials, development documents and other related contents of apinto. \n\n# README\n\n本文档由 [VuePress](https://v2.vuepress.vuejs.org/) 搭建\n\n### 项目结构\n\n```bash\n.\n├── README.md       # 本文档\n├── index.md        # 首页\n├── components/     # markdown 文档中需要运行的vue组件，例如定制化的首页\n├── .vuepress/      # vuepress配置，构建后的静态资源也在该文件夹下。\n├── assets/         # 静态资源，主要是放置图片\n├── public/         # 不需要编译的公共资源，如 favicon.ico,logo等\n├── docs/           # 各详细文档\n├── package.json    # 依赖配置\n└── yarn.lock       # 依赖配置\n```\n\n### 如何开始编辑\n\n#### 第一步\n\n环境准备： 需要安装12.20.0或14.13.0或大于等于15.0.0版本的node\n\n依赖安装：确保项目下`package.json`文件内的依赖已用yarn安装。\n\n#### 第二步\n\n运行 VuePress 环境\n\n```bash\n$ yarn dev\n```\n\n运行成功后，可以在`localhost:8080/`实时查看编辑结果。\n\n#### 第三步\n\n用编辑器打开项目 `/docs/` 目录下需要编辑的`.md`文档，或新建`.md`文档，进行编辑。`.md`文件和`.vue`的变动，都可以在步骤一所打开的页面上实时看到最终效果。\n\n#### 文档中的配置\n\nVuePress 提供了一些配置选项，用于控制`.md`文档的细节，目前本项目所用不多，如需要查阅，可参考官方的[Frontmatter](https://v2.vuepress.vuejs.org/reference/default-theme/frontmatter.html)。\n\n#### 文档中的静态资源\n\n在`.md`文件中的图片，目前约定放置在`/assets/`文件夹下，在`.md`文件中使用相对路径引入即可。\n\n#### 如何在 markdown 嵌入 vue 组件\n\n在`.md`文件中嵌入 vue 组件的语法非常简单，只需要在components文件夹中编写组件代码，便可在markdown中直接使用。\n\n在`.vue`组件中可以使用 css 预编译器描述样式，本项目选用了`stylus`。\n\n```markdown\n...markdown 语法内容...\n\n\u003cTest /\u003e\n\n...markdown 语法内容...\n```\n\n关于自定义组件的注册和使用，具体可以参照官方文档的[register-components](https://v2.vuepress.vuejs.org/reference/plugin/register-components.html)。\n\n### 如何构建\n\n构建命令为：\n\n```bash\n$ yarn build\n```\n\n构建成功后，会在`/.vuepress`下创建名为 `dist/`的文件夹，其中内容即是构建后的静态资源，如果需要在本地预览，可以运行`yarn dev`命令，在本地临时启动一个静态资源服务器，即可预览构建后的最终效果。\n\n也可以将`dist/`中的内容放置到正式服务器上浏览。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feolinker%2Fapinto-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feolinker%2Fapinto-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feolinker%2Fapinto-docs/lists"}