{"id":14156562,"url":"https://github.com/umijs/dumi-template","last_synced_at":"2025-04-06T08:11:27.244Z","repository":{"id":40307678,"uuid":"324046627","full_name":"umijs/dumi-template","owner":"umijs","description":"🌟 A doc template can assist you to develop libraries \u0026 write docs.","archived":false,"fork":false,"pushed_at":"2022-05-13T13:20:04.000Z","size":660,"stargazers_count":99,"open_issues_count":1,"forks_count":149,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-30T07:08:04.657Z","etag":null,"topics":["dumi","dumi-demo","react","template","umijs"],"latest_commit_sha":null,"homepage":"https://umijs.github.io/dumi-template/","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/umijs.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}},"created_at":"2020-12-24T02:29:52.000Z","updated_at":"2025-01-03T11:59:05.000Z","dependencies_parsed_at":"2022-08-25T20:21:43.429Z","dependency_job_id":null,"html_url":"https://github.com/umijs/dumi-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umijs%2Fdumi-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umijs%2Fdumi-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umijs%2Fdumi-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umijs%2Fdumi-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umijs","download_url":"https://codeload.github.com/umijs/dumi-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247451652,"owners_count":20940939,"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":["dumi","dumi-demo","react","template","umijs"],"created_at":"2024-08-17T08:06:26.373Z","updated_at":"2025-04-06T08:11:27.226Z","avatar_url":"https://github.com/umijs.png","language":"TypeScript","funding_links":[],"categories":["react"],"sub_categories":[],"readme":"# 🌟 Dumi Template\n\nA doc template can assist you to develop libraries \u0026 write docs.\n\nEnglish | [简体中文](./README.zh-CN.md)\n\n## 🚀 How to use?\n\n![](https://gw.alipayobjects.com/zos/bmw-prod/91791904-cdde-4408-959d-72fd0c9049b1/kj80x6lv_w1918_h352.png)\n\n## ✨ Online preview\n\nhttps://umijs.github.io/dumi-template/\n\n## 📒 Catalog Introduction\n\n```\n├── docs                   Component documentation\n│   ├── index.md           Home page\n│   └── **.**              Site Directory Document\n├── src                    Component home directory\n│   ├── index.ts           Component registration\n│   └── Foo                Component development\n├── .eslintrc.js           eslint config\n├── .fatherrc.ts           father config\n├── .umirc.ts              dumi config\n└── tsconfig.json          typescript config\n```\n\nThe rest of the documents can be consulted by yourself.\n\n## 🤖 Command introduction\n\n| Name                    | Description               | Remarks                                                                                                            |\n| ----------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| `npm run start`         | Project begining          | Document usage [dumi](https://github.com/umijs/dumi), component development and documentation development together |\n| `npm run test`          | Component test            | -                                                                                                                  |\n| `npm run test:coverage` | Code coverage review      | -                                                                                                                  |\n| `npm run prettier`      | Code prettier             | -                                                                                                                  |\n| `npm run build`         | Component packaging       | Use [father](https://github.com/umijs/father)                                                                      |\n| `npm run release`       | Component package release | -                                                                                                                  |\n| `npm run docs:build`    | Document packaging        | -                                                                                                                  |\n| `npm run docs:deploy`   | Document release          | The default is to use GitHub Pages                                                                                 |\n| `npm run deploy`        | Document package release  | -                                                                                                                  |\n\n### README Badge\n\nUsing dumi ? Add a README badge to show it off: [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)\n\n```\n[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)\n```\n\n## Discuss group\n\n\u003cdiv\u003e\n  \u003cimg data-type=\"dingtalk\" src=\"https://gw.alipayobjects.com/zos/bmw-prod/ce3439e7-3bf9-4031-b823-6473439ec9e6/kxkiis4c_w1004_h1346.jpeg\" width=\"300\" /\u003e\n  \u003cimg data-type=\"wechat\" src=\"https://gw.alipayobjects.com/zos/bmw-prod/c18bc2a5-719a-48ca-b225-c79ef88bfb43/k7m10ymd_w1004_h1346.jpeg\" width=\"300\" /\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumijs%2Fdumi-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumijs%2Fdumi-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumijs%2Fdumi-template/lists"}