Updates

fjc0k · Nov 1, 2023 · 6feb73e · 6feb73e
1 parent c306ba6
commit 6feb73e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/handbook/index.html b/handbook/index.html
@@ -39,7 +39,7 @@
  <body>
  <div id="root"><div class="__dumi-default-layout" data-route="/" data-show-sidemenu="true" data-show-slugs="false" data-site-mode="false" data-gapless="false"><div class="__dumi-default-navbar" data-mode="doc"><button class="__dumi-default-navbar-toggle"></button><a class="__dumi-default-navbar-logo" style="background-image:url(&#x27;https://cdn.jsdelivr.net/gh/fjc0k/yapi-to-typescript/assets/logo.png&#x27;)" href="/yapi-to-typescript/handbook//">YTT</a><nav><div class="__dumi-default-search"><input type="search" class="__dumi-default-search-input" value=""/><ul></ul></div><div class="__dumi-default-navbar-tool"><div class="__dumi-default-dark"><div class="__dumi-default-dark-switch "></div></div></div></nav></div><div class="__dumi-default-menu" data-mode="doc"><div class="__dumi-default-menu-inner"><div class="__dumi-default-menu-header"><a class="__dumi-default-menu-logo" style="background-image:url(&#x27;https://cdn.jsdelivr.net/gh/fjc0k/yapi-to-typescript/assets/logo.png&#x27;)" href="/yapi-to-typescript/handbook//"></a><h1>YTT</h1><p>一个 YApi 代码生成工具</p><p><object type="image/svg+xml" data="https://img.shields.io/github/stars/fjc0k/yapi-to-typescript?style=social"></object></p></div><div class="__dumi-default-menu-mobile-area"><div class="__dumi-default-dark"><div class="__dumi-default-dark-switch "><button title="Dark theme" class="__dumi-default-dark-moon "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http:https://www.w3.org/2000/svg" p-id="3854" width="22" height="22"><path d="M991.816611 674.909091a69.166545 69.166545 0 0 0-51.665455-23.272727 70.795636 70.795636 0 0 0-27.438545 5.585454A415.674182 415.674182 0 0 1 754.993338 698.181818c-209.594182 0-393.472-184.785455-393.472-395.636363 0-52.363636 38.539636-119.621818 69.515637-173.614546 4.887273-8.610909 9.634909-16.756364 14.103272-24.901818A69.818182 69.818182 0 0 0 384.631156 0a70.842182 70.842182 0 0 0-27.438545 5.585455C161.678429 90.298182 14.362065 307.898182 14.362065 512c0 282.298182 238.824727 512 532.38691 512a522.286545 522.286545 0 0 0 453.957818-268.334545A69.818182 69.818182 0 0 0 991.816611 674.909091zM546.679156 954.181818c-248.785455 0-462.941091-192-462.941091-442.181818 0-186.647273 140.637091-372.829091 300.939637-442.181818-36.817455 65.629091-92.578909 151.970909-92.578909 232.727273 0 250.181818 214.109091 465.454545 462.917818 465.454545a488.331636 488.331636 0 0 0 185.181091-46.545455 453.003636 453.003636 0 0 1-393.565091 232.727273z m103.656728-669.323636l-14.266182 83.781818a34.909091 34.909091 0 0 0 50.362182 36.770909l74.775272-39.563636 74.752 39.563636a36.142545 36.142545 0 0 0 16.174546 3.956364 34.909091 34.909091 0 0 0 34.210909-40.727273l-14.289455-83.781818 60.509091-59.345455a35.025455 35.025455 0 0 0-19.223272-59.578182l-83.61891-12.101818-37.376-76.101818a34.56 34.56 0 0 0-62.254545 0l-37.376 76.101818-83.618909 12.101818a34.909091 34.909091 0 0 0-19.246546 59.578182z m70.423272-64.698182a34.280727 34.280727 0 0 0 26.135273-19.083636l14.312727-29.090909 14.336 29.090909a34.257455 34.257455 0 0 0 26.135273 19.083636l32.046546 4.887273-23.272728 22.574545a35.234909 35.234909 0 0 0-10.007272 30.952727l5.46909 32.116364-28.625454-15.127273a34.490182 34.490182 0 0 0-32.302546 0l-28.695272 15.127273 5.469091-32.116364a35.141818 35.141818 0 0 0-9.984-30.952727l-23.272728-22.574545z" p-id="3855"></path></svg></button><button title="Light theme" class="__dumi-default-dark-sun "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http:https://www.w3.org/2000/svg" p-id="4026" width="22" height="22"><path d="M915.2 476.16h-43.968c-24.704 0-44.736 16-44.736 35.84s20.032 35.904 44.736 35.904H915.2c24.768 0 44.8-16.064 44.8-35.904s-20.032-35.84-44.8-35.84zM512 265.6c-136.704 0-246.464 109.824-246.464 246.4 0 136.704 109.76 246.464 246.464 246.464S758.4 648.704 758.4 512c0-136.576-109.696-246.4-246.4-246.4z m0 425.6c-99.008 0-179.2-80.128-179.2-179.2 0-98.944 80.192-179.2 179.2-179.2S691.2 413.056 691.2 512c0 99.072-80.192 179.2-179.2 179.2zM197.44 512c0-19.84-19.136-35.84-43.904-35.84H108.8c-24.768 0-44.8 16-44.8 35.84s20.032 35.904 44.8 35.904h44.736c24.768 0 43.904-16.064 43.904-35.904zM512 198.464c19.776 0 35.84-20.032 35.84-44.8v-44.8C547.84 84.032 531.84 64 512 64s-35.904 20.032-35.904 44.8v44.8c0 24.768 16.128 44.864 35.904 44.864z m0 627.136c-19.776 0-35.904 20.032-35.904 44.8v44.736C476.096 940.032 492.16 960 512 960s35.84-20.032 35.84-44.8v-44.736c0-24.768-16.064-44.864-35.84-44.864z m329.92-592.832c17.472-17.536 20.288-43.072 6.4-57.024-14.016-14.016-39.488-11.2-57.024 6.336-4.736 4.864-26.496 26.496-31.36 31.36-17.472 17.472-20.288 43.008-6.336 57.024 13.952 14.016 39.488 11.2 57.024-6.336 4.8-4.864 26.496-26.56 31.296-31.36zM213.376 759.936c-4.864 4.8-26.56 26.624-31.36 31.36-17.472 17.472-20.288 42.944-6.4 56.96 14.016 13.952 39.552 11.2 57.024-6.336 4.8-4.736 26.56-26.496 31.36-31.36 17.472-17.472 20.288-43.008 6.336-56.96-14.016-13.952-39.552-11.072-56.96 6.336z m19.328-577.92c-17.536-17.536-43.008-20.352-57.024-6.336-14.08 14.016-11.136 39.488 6.336 57.024 4.864 4.864 26.496 26.56 31.36 31.424 17.536 17.408 43.008 20.288 56.96 6.336 14.016-14.016 11.264-39.488-6.336-57.024-4.736-4.864-26.496-26.56-31.296-31.424z m527.168 628.608c4.864 4.864 26.624 26.624 31.36 31.424 17.536 17.408 43.072 20.224 57.088 6.336 13.952-14.016 11.072-39.552-6.4-57.024-4.864-4.8-26.56-26.496-31.36-31.36-17.472-17.408-43.072-20.288-57.024-6.336-13.952 14.016-11.008 39.488 6.336 56.96z" p-id="4027"></path></svg></button><button title="Default to system" class="__dumi-default-dark-auto "><svg viewBox="0 0 1024 1024" version="1.1" xmlns="http:https://www.w3.org/2000/svg" p-id="11002" width="22" height="22"><path d="M127.658667 492.885333c0-51.882667 10.24-101.717333 30.378666-149.162666s47.786667-88.064 81.92-122.538667 75.093333-61.781333 122.538667-81.92 96.938667-30.378667 149.162667-30.378667 101.717333 10.24 149.162666 30.378667 88.405333 47.786667 122.88 81.92 61.781333 75.093333 81.92 122.538667 30.378667 96.938667 30.378667 149.162666-10.24 101.717333-30.378667 149.162667-47.786667 88.405333-81.92 122.88-75.093333 61.781333-122.88 81.92-97.28 30.378667-149.162666 30.378667-101.717333-10.24-149.162667-30.378667-88.064-47.786667-122.538667-81.92-61.781333-75.093333-81.92-122.88-30.378667-96.938667-30.378666-149.162667z m329.045333 0c0 130.048 13.994667 244.394667 41.984 343.381334h12.970667c46.762667 0 91.136-9.216 133.461333-27.306667s78.848-42.666667 109.568-73.386667 54.954667-67.242667 73.386667-109.568 27.306667-86.698667 27.306666-133.461333c0-46.421333-9.216-90.794667-27.306666-133.12s-42.666667-78.848-73.386667-109.568-67.242667-54.954667-109.568-73.386667-86.698667-27.306667-133.461333-27.306666h-11.605334c-28.672 123.562667-43.349333 237.909333-43.349333 343.722666z" p-id="11003"></path></svg></button></div></div></div><ul class="__dumi-default-menu-list"><li><a aria-current="page" class="active" href="/yapi-to-typescript/handbook//">介绍</a><ul role="slug-list"><li title="特性" data-depth="2"><a href="/yapi-to-typescript/handbook//#特性"><span>特性</span></a></li><li title="环境要求" data-depth="2"><a href="/yapi-to-typescript/handbook//#环境要求"><span>环境要求</span></a></li><li title="安装" data-depth="2"><a href="/yapi-to-typescript/handbook//#安装"><span>安装</span></a></li><li title="交流群" data-depth="2"><a href="/yapi-to-typescript/handbook//#交流群"><span>交流群</span></a></li><li title="许可" data-depth="2"><a href="/yapi-to-typescript/handbook//#许可"><span>许可</span></a></li></ul></li><li><a href="/yapi-to-typescript/handbook//config.html">配置</a></li><li><a href="/yapi-to-typescript/handbook//usage.html">使用</a></li><li><a href="/yapi-to-typescript/handbook//request.html">统一请求函数</a></li><li><a href="/yapi-to-typescript/handbook//changelog.html">更新日志</a></li></ul></div></div><div class="__dumi-default-layout-content"><div class="markdown"><h1 id="介绍"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#介绍"><span class="icon icon-link"></span></a>介绍</h1><p><code>YApi to TypeScript</code>（简称 <code>ytt</code>） 是一个代码生成工具，其可根据 <a target="_blank" rel="noopener noreferrer" href="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/YMFE/yapi">YApi<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> 或 <a target="_blank" rel="noopener noreferrer" href="https://swagger.io/">Swagger<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> 的接口定义生成 TypeScript 或 JavaScript 的接口类型及其请求函数代码。</p><h2 id="特性"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#特性"><span class="icon icon-link"></span></a>特性</h2><ul><li>支持多服务器、多项目、多分类</li><li>支持预处理接口信息</li><li>可自定义类型或函数名称</li><li>完整的注释</li><li>支持生成 React Hooks 的请求代码</li><li>支持参数路径</li><li>支持上传文件</li><li>支持生成 JavaScript 代码</li><li>支持 Swagger</li></ul><h2 id="环境要求"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#环境要求"><span class="icon icon-link"></span></a>环境要求</h2><p>首先得有 <a target="_blank" rel="noopener noreferrer" href="https://nodejs.org/en/">Node.js<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>，并确保其版本 <code>&gt;= 10.19.0</code>。同时：</p><ul><li>对于基于 YApi 的项目，要求 YApi 的版本必须 <code>&gt;= 1.5.12</code>。</li><li>对于基于 Swagger 的项目，仅支持 <code>Swagger 2</code> 和 <code>OpenAPI 3</code>。</li></ul><h2 id="安装"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#安装"><span class="icon icon-link"></span></a>安装</h2><p>选择你常用的包管理器将 <code>yapi-to-typescript</code> 加入项目依赖即可：</p><div class="__dumi-default-code-block"><pre class="prism-code language-bash"><button class="__dumi-default-icon __dumi-default-code-block-copy-btn" data-status="ready"></button><div class="token-line"><span class="token comment"># npm</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"></span><span class="token function">npm</span><span class="token plain"> i yapi-to-typescript</span></div><div class="token-line"><span class="token plain">
 </span></div><div class="token-line"><span class="token plain"></span><span class="token comment"># yarn</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"></span><span class="token function">yarn</span><span class="token plain"> </span><span class="token function">add</span><span class="token plain"> yapi-to-typescript</span></div><div class="token-line"><span class="token plain">
-</span></div><div class="token-line"><span class="token plain"></span><span class="token comment"># pnpm</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"></span><span class="token function">pnpm</span><span class="token plain"> </span><span class="token function">add</span><span class="token plain"> yapi-to-typescript</span></div></pre></div><p>如果你在国内且没有任何科学<span style="font-size:0">习</span>上网措施，上述安装过程可能会非常慢，推荐你使用 <a target="_blank" rel="noopener noreferrer" href="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/fjc0k/tbify">tbify<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>，这个工具可以自动将 npm、yarn 等包管理工具连上国内的淘宝镜像，加速安装。</p><h2 id="交流群"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#交流群"><span class="icon icon-link"></span></a>交流群</h2><p>钉钉扫码加入交流群：</p><img src="https://cdn.jsdelivr.net/gh/fjc0k/yapi-to-typescript@master/assets/dingtalk.png" width="300"/><h2 id="许可"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#许可"><span class="icon icon-link"></span></a>许可</h2><p><a target="_blank" rel="noopener noreferrer" href="https://github.com/fjc0k/yapi-to-typescript/blob/master/LICENSE">MIT<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> © <a target="_blank" rel="noopener noreferrer" href="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/fjc0k">Jay Fong<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p></div><div class="__dumi-default-layout-footer-meta"><a target="_blank" rel="noopener noreferrer" href="https://github.com/fjc0k/yapi-to-typescript/edit/master/docs/index.md">在 GitHub 上编辑此页<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a><span data-updated-text="最后更新时间：">1/18/2022 14:27:12</span></div></div></div></div>
+</span></div><div class="token-line"><span class="token plain"></span><span class="token comment"># pnpm</span><span class="token plain"></span></div><div class="token-line"><span class="token plain"></span><span class="token function">pnpm</span><span class="token plain"> </span><span class="token function">add</span><span class="token plain"> yapi-to-typescript</span></div></pre></div><p>如果你在国内且没有任何科学<span style="font-size:0">习</span>上网措施，上述安装过程可能会非常慢，推荐你使用 <a target="_blank" rel="noopener noreferrer" href="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/fjc0k/tbify">tbify<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>，这个工具可以自动将 npm、yarn 等包管理工具连上国内的淘宝镜像，加速安装。</p><h2 id="交流群"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#交流群"><span class="icon icon-link"></span></a>交流群</h2><p>钉钉扫码加入交流群：</p><img src="https://cdn.jsdelivr.net/gh/fjc0k/yapi-to-typescript@master/assets/dingtalk.jpg?v=1111" width="300"/><h2 id="许可"><a aria-hidden="true" tabindex="-1" href="/yapi-to-typescript/handbook//#许可"><span class="icon icon-link"></span></a>许可</h2><p><a target="_blank" rel="noopener noreferrer" href="https://github.com/fjc0k/yapi-to-typescript/blob/master/LICENSE">MIT<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> © <a target="_blank" rel="noopener noreferrer" href="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/fjc0k">Jay Fong<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p></div><div class="__dumi-default-layout-footer-meta"><a target="_blank" rel="noopener noreferrer" href="https://github.com/fjc0k/yapi-to-typescript/edit/master/docs/index.md">在 GitHub 上编辑此页<svg xmlns="http:https://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="__dumi-default-external-link-icon"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a><span data-updated-text="最后更新时间：">11/1/2023 15:02:54</span></div></div></div></div>
  <script>
  window.g_useSSR = true;
  window.g_initialProps = {};

diff --git a/handbook/umi.js b/handbook/umi.js