{"id":29926656,"url":"https://github.com/ecomfe/veui-docs","last_synced_at":"2025-08-02T12:43:06.031Z","repository":{"id":37801234,"uuid":"287165423","full_name":"ecomfe/veui-docs","owner":"ecomfe","description":"Documentation website for VEUI.","archived":false,"fork":false,"pushed_at":"2024-09-09T08:46:01.000Z","size":8947,"stargazers_count":8,"open_issues_count":4,"forks_count":28,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-05-25T08:05:22.849Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://veui.dev","language":"JavaScript","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/ecomfe.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":"2020-08-13T02:49:31.000Z","updated_at":"2024-09-09T08:46:06.000Z","dependencies_parsed_at":"2023-10-11T05:37:47.710Z","dependency_job_id":"7dd15f59-73e5-474d-9aa5-fd1a0b33572d","html_url":"https://github.com/ecomfe/veui-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ecomfe/veui-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomfe%2Fveui-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomfe%2Fveui-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomfe%2Fveui-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomfe%2Fveui-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecomfe","download_url":"https://codeload.github.com/ecomfe/veui-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomfe%2Fveui-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268392180,"owners_count":24243297,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-08-02T12:42:26.859Z","updated_at":"2025-08-02T12:43:06.007Z","avatar_url":"https://github.com/ecomfe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# veui/docs\n\n\u003e VEUI 文档。\n\n## 本地安装\n\n`git clone` 到本地后，在项目根目录下运行：\n\n```shell\nnpm i\nnpm run dev\n```\n\n后在浏览访问 `http://localhost:3000` 即可。\n\n## 文档编写\n\n开发相关文档位于 `one/docs/development` 下。文档目录结构与网站的目录结构一致，新建 `.md` 文件后需要在 `one/docs/nav.json` 中新建相应的条目，作为目录配置。添加 `sub: true` 将缩进一个层级。\n\n### 组件文档结构\n\n每个组件的文档请按如下顺序编写：\n\n1. 示例\n2. API\n\n  1. 属性\n  2. 插槽\n  3. 作用域插槽\n  4. 事件\n  5. 方法\n\n3. 全局配置\n\n  1. `veui` 中的默认\n  2. `veui-theme-dls` 中的默认配置\n\n4. 图标名称\n\n另外，如有关联组件请在最开始进行说明。比如：\n\n```md\n:::tip\n`Select` 组件可以内联 [`Option`](./option) 或 [`OptionGroup`](./option-group) 组件使用。\n:::\n```\n\n### 在文档中插入示例\n\n使用 Markdown 的 shortcode 语法，如下：\n\n```md\n[[ demo src=\"../demo/button.vue\"]]\n```\n\n路径为 demo 文件相对于当前文档文件的路径。Demo 文件是一个 Vue 单文件组件，最后会将代码展示到文档中。可以编写多个 `\u003cstyle\u003e` 块，如果带上自定义的 `docs` 属性，则会从文档的源码中去除，用来写一些不想输出到文档里的样式（建议文档里只展示和演示的用法相关的样式代码）。\n\n可以为 demo 书写内嵌的说明，方法为在 demo 文件中增加 `\u003cdocs\u003e` 自定义块，比如：\n\n```html\n\u003cdocs\u003e\n具体内容请参考项目 [repo](https://github.com/ecomfe/veui)。\n\u003c/docs\u003e\n```\n\n### 扩展 Markdown 语法\n\n#### 自定义块\n\n因为 Markdown 原生不支持对特定区块设定自定义的 `class`，直接书写 HTML 标签的话内部的内容就无法直接写 Markdown 了。故扩展了如下自定义块的语法：\n\n```md\n:::tip\n这是一条小贴士。\n:::\n```\n\n将会渲染为：\n\n```html\n\u003cdiv class=\"tip custom-block\"\u003e这是一条小贴士。\u003c/div\u003e\n```\n\n目前支持的状态类型有 `tip`/`warning`/`alert`。\n\n标注 `v-model` 及 `.sync` 的属性/事件请使用如下格式：\n\n```md\n:::badges\n`v-model`\n:::\n```\n\n#### 内联引用\n\nMarkdown 中书写表格比较麻烦，如果想在里面嵌入格式比较复杂的内容，原生语法 + GFM 扩展都是不够用的。这里提供了一个定义可被引用内容+将对应内容块内联到文档内任意位置的语法。\n\n定义可被引用的内容：\n\n```md\n^^^ui\n内容\n^^^\n```\n\n引用方式和脚注的引用方式相同，只是会将内容直接嵌入当前位置：\n\n```md\n[^ui]\n```\n\n#### 可折叠区块\n\n有时内容过长不利于阅读全文，故扩展了如下语法支持默认收起的区块，可点击展开。\n\n```md\n+++摘要内容\n详细内容\n+++\n```\n\n## 文案规范\n\n参见[《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines)。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomfe%2Fveui-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecomfe%2Fveui-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomfe%2Fveui-docs/lists"}