Deploying to docs from @ LiteyukiStudio/LiteyukiBot@d2704818d9 ๐Ÿš€

This commit is contained in:
2024-08-31 12:24:35 +00:00
parent 056cfa568c
commit 44a7c3ad08
120 changed files with 468 additions and 412 deletions

File diff suppressed because one or more lines are too long

View File

@ -1 +1 @@
import{t as p}from"./chunks/theme.Cfwe0ZOB.js";import{U as o,a5 as u,a6 as c,a7 as l,a8 as f,a9 as d,aa as m,ab as h,ac as g,ad as A,ae as y,d as P,u as v,y as C,x as b,af as w,ag as E,ah as R,ai as S}from"./chunks/framework.C3o_UkTa.js";function i(e){if(e.extends){const a=i(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const s=i(p),T=P({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=v();return C(()=>{b(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&w(),E(),R(),s.setup&&s.setup(),()=>S(s.Layout)}});async function x(){globalThis.__VITEPRESS__=!0;const e=_(),a=D();a.provide(c,e);const t=l(e.route);return a.provide(f,t),a.component("Content",d),a.component("ClientOnly",m),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),s.enhanceApp&&await s.enhanceApp({app:a,router:e,siteData:h}),{app:a,router:e,data:t}}function D(){return g(T)}function _(){let e=o,a;return A(t=>{let n=y(t),r=null;return n&&(e&&(a=n),(e||a===n)&&(n=n.replace(/\.js$/,".lean.js")),r=import(n)),o&&(e=!1),r},s.NotFound)}o&&x().then(({app:e,router:a,data:t})=>{a.go().then(()=>{u(a.route,t.site),e.mount("#app")})});export{x as createApp}; import{t as p}from"./chunks/theme.DMJ5TBe0.js";import{U as o,a5 as u,a6 as c,a7 as l,a8 as f,a9 as d,aa as m,ab as h,ac as g,ad as A,ae as y,d as P,u as v,y as C,x as b,af as w,ag as E,ah as R,ai as S}from"./chunks/framework.C3o_UkTa.js";function i(e){if(e.extends){const a=i(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const s=i(p),T=P({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=v();return C(()=>{b(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&w(),E(),R(),s.setup&&s.setup(),()=>S(s.Layout)}});async function x(){globalThis.__VITEPRESS__=!0;const e=_(),a=D();a.provide(c,e);const t=l(e.route);return a.provide(f,t),a.component("Content",d),a.component("ClientOnly",m),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),s.enhanceApp&&await s.enhanceApp({app:a,router:e,siteData:h}),{app:a,router:e,data:t}}function D(){return g(T)}function _(){let e=o,a;return A(t=>{let n=y(t),r=null;return n&&(e&&(a=n),(e||a===n)&&(n=n.replace(/\.js$/,".lean.js")),r=import(n)),o&&(e=!1),r},s.NotFound)}o&&x().then(({app:e,router:a,data:t})=>{a.go().then(()=>{u(a.route,t.site),e.mount("#app")})});export{x as createApp};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1 @@
import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.C3o_UkTa.js";const p=JSON.parse('{"title":"ๅผ€ๅ‘ๆŒ‡ๅ—","description":"","frontmatter":{"title":"ๅผ€ๅ‘ๆŒ‡ๅ—","order":0},"headers":[],"relativePath":"dev/guide.md","filePath":"zh/dev/guide.md","lastUpdated":1725107025000}'),l={name:"dev/guide.md"},r=o('<h1 id="ๅผ€ๅ‘ๆŒ‡ๅ—" tabindex="-1">ๅผ€ๅ‘ๆŒ‡ๅ— <a class="header-anchor" href="#ๅผ€ๅ‘ๆŒ‡ๅ—" aria-label="Permalink to &quot;ๅผ€ๅ‘ๆŒ‡ๅ—&quot;">โ€‹</a></h1><h2 id="ๅฆ‚ไฝ•ๅผ€ๅ‘" tabindex="-1">ๅฆ‚ไฝ•ๅผ€ๅ‘ <a class="header-anchor" href="#ๅฆ‚ไฝ•ๅผ€ๅ‘" aria-label="Permalink to &quot;ๅฆ‚ไฝ•ๅผ€ๅ‘&quot;">โ€‹</a></h2><p>ๆ’ไปถๅผ€ๅ‘ๆ— ้œ€้˜…่ฏปๆœฌๆ–‡ๆกฃ๏ผŒ่ฏท้˜…่ฏป<a href="./plugin.html">ๆ’ไปถๅผ€ๅ‘ๆ–‡ๆกฃ</a>ๅ’Œ<a href="./api/">API ๅผ•็”จ</a>ใ€‚</p><p>ๅฆ‚้œ€ๅพ€่ฝป้›ชไป“ๅบ“ๆไบคไปฃ็ ๏ผŒ่ฏท้˜…่ฏปไปฅไธ‹ๅ†…ๅฎน๏ผš</p><ol><li>้ฆ–ๅ…ˆ<a href="https://github.com/LiteyukiStudio/LiteyukiBot/fork" target="_blank" rel="noreferrer">fork</a>ไธ€ไปฝ่ฝป้›ชไป“ๅบ“ๅˆฐไฝ ็š„ไธชไบบ/็ป„็ป‡่ดฆๆˆทไธ‹ใ€‚</li><li>ๅœจไฝ ็š„ไป“ๅบ“ไธญ่ฟ›่กŒๅผ€ๅ‘ใ€‚</li><li>ๅœจไฝ ็š„ไป“ๅบ“ไธญๅˆ›ๅปบไธ€ไธชๆ–ฐ็š„ๅˆ†ๆ”ฏ๏ผŒๅฐ†ไฝ ็š„ไปฃ็ ๆไบคๅˆฐ่ฟ™ไธชๅˆ†ๆ”ฏใ€‚</li><li>ๅœจไฝ ็š„ไป“ๅบ“ไธญๅˆ›ๅปบไธ€ไธชPull Request๏ผŒๅฐ†ไฝ ็š„ๅˆ†ๆ”ฏๅˆๅนถๅˆฐ่ฝป้›ชไป“ๅบ“็š„<code>main</code>ๅˆ†ๆ”ฏใ€‚</li></ol><p>ๅ‚ไธŽๅผ€ๅ‘้ป˜่ฎคไฝ ๅทฒ็ปไบ†่งฃPython่ฏญ่จ€ๅ’Œ่ฝป้›ชๆก†ๆžถ็š„ๅŸบๆœฌไฝฟ็”จๆ–นๆณ•๏ผŒๅฆ‚ๆžœๆ˜ฏๆ–‡ๆกฃ็›ธๅ…ณ็š„ๅผ€ๅ‘๏ผŒ่ฏท็กฎไฟไฝ ไบ†่งฃMarkdown่ฏญๆณ•ๅ’ŒๅŸบๆœฌๅ‰็ซฏ็Ÿฅ่ฏ†ใ€‚ ๅ‡บ็Žฐๅ†ฒ็ช่ฏทไธŽไป“ๅบ“็ปดๆŠค่€…่”็ณปใ€‚</p><h3 id="ๅปบ่ฎฎ" tabindex="-1">ๅปบ่ฎฎ <a class="header-anchor" href="#ๅปบ่ฎฎ" aria-label="Permalink to &quot;ๅปบ่ฎฎ&quot;">โ€‹</a></h3><ul><li>ๅผ€ๅ‘่ฟ‡็จ‹ไธญๅฏไปฅไฝฟ็”จ<code>mypy</code>, <code>flake8</code>, <code>black</code>็ญ‰ๅทฅๅ…ท่ฟ›่กŒไปฃ็ ๆฃ€ๆŸฅๅ’Œๆ ผๅผๅŒ–ใ€‚</li><li>ๅฏ็”จๅผ€ๅ‘่€…ๆจกๅผ๏ผŒๅฏไปฅๅœจ<code>config.yml</code>ไธญ่ฎพ็ฝฎ<code>dev_mode: true</code>๏ผŒ่ฟ™ๆ ทๅฏไปฅๅœจๆŽงๅˆถๅฐ็œ‹ๅˆฐๆ›ดๅคš็š„่ฐƒ่ฏ•ไฟกๆฏใ€‚</li></ul><h2 id="่ง„่ŒƒๅŒ–" tabindex="-1">่ง„่ŒƒๅŒ– <a class="header-anchor" href="#่ง„่ŒƒๅŒ–" aria-label="Permalink to &quot;่ง„่ŒƒๅŒ–&quot;">โ€‹</a></h2><ul><li>ไปฃ็ ่ฏท้ตๅพช<a href="https://pep8.org/" target="_blank" rel="noreferrer"><code>PEP8</code></a>ๅ’Œ<a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Python Style Guide</code></a></li><li>ๆญคๅค–๏ผŒๆไบคๅˆฐ่ฝป้›ชไป“ๅบ“็š„ไปฃ็ ๏ผŒ่ฏท้ตๅพชไปฅไธ‹่ง„่Œƒ๏ผš <ul><li>่ฏท็กฎไฟไปฃ็ ๆ˜ฏๅฏ่ฟ่กŒ็š„๏ผŒๆฒกๆœ‰ๅฑๅฎณ็š„ใ€‚</li><li>่ฏท็กฎไฟไปฃ็ ็š„็ฑปๅž‹ๆ็คบๆ˜ฏๆญฃ็กฎ็š„ใ€‚</li><li>่ฏท็กฎไฟๆณจ้‡Š้ฃŽๆ ผไธบ<a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Docstring</code></a>ๆˆ–<a href="https://github.com/LiteyukiStudio/litedoc" target="_blank" rel="noreferrer"><code>Liteyuki Docstring</code></a>(ๆŽจ่)ไปฅไฟ่ฏLitedoc่ƒฝๅคŸๆญฃ็กฎ่งฃๆžๅนถ็”Ÿๆˆๆ–‡ๆกฃใ€‚</li><li>่‹ฅๆœ‰้ขๅ‘ๆ™ฎ้€š็”จๆˆท้ƒจๅˆ†๏ผŒ่ฏท็กฎไฟๆ–‡ๆกฃๆ˜ฏๅฎŒๅ–„็š„(ๆฏ็ง่ฏญ่จ€้ƒฝๆœ‰ๅฏนๅบ”็š„ๆ–‡ๆกฃ)ใ€‚</li></ul></li><li>ๆ–‡ๆกฃ่ฏท้ตๅพช<a href="https://www.markdownguide.org/" target="_blank" rel="noreferrer"><code>Markdown</code></a>่ฏญๆณ•๏ผŒๅนถไธ”ๆ”ฏๆŒvitepress็›ธๅ…ณๅ†…ๅฎน๏ผš <ul><li>็ผ–่พ‘ๆ–‡ๆกฃๆ—ถๆฏไธช่ฏญ่จ€็š„ๆ–‡ๆกฃ้ƒฝ่ฆไฟฎ่ฎขใ€‚</li><li>่ฏท็กฎไฟๆ–‡ๆกฃๅ†…็š„้“พๆŽฅๆ˜ฏๆญฃ็กฎ็š„๏ผŒไธ่ฆๅ‡บ็Žฐๆ— ๆณ•่ฎฟ้—ฎ็š„้“พๆŽฅใ€‚</li><li>่ฏท็กฎไฟ<strong>็”จๆˆทๆ–‡ๆกฃ</strong>ๆ˜ฏ้€šไฟ—ๆ˜“ๆ‡‚็š„๏ผŒ<strong>ๅผ€ๅ‘ๆ–‡ๆกฃ</strong>ๆ˜ฏ่ฏฆ็ป†็š„ใ€‚</li></ul></li></ul><h2 id="ๆœ€ๅŽ" tabindex="-1">ๆœ€ๅŽ <a class="header-anchor" href="#ๆœ€ๅŽ" aria-label="Permalink to &quot;ๆœ€ๅŽ&quot;">โ€‹</a></h2><ul><li>ๆœฌ้กน็›ฎๆ˜ฏไธ€ไธช้ž็›ˆๅˆฉ็š„ๅผ€ๆบ้กน็›ฎ๏ผŒๆˆ‘ไปฌๆฌข่ฟŽไปปไฝ•ไบบๅ‚ไธŽๅผ€ๅ‘๏ผŒไฝ ็š„่ดก็Œฎๅฐ†ไผšไฝฟ่ฝป้›ชๅ˜ๅพ—ๆ›ดๅฅฝใ€‚</li></ul>',12),i=[r];function d(c,n,h,s,u,g){return t(),a("div",null,i)}const f=e(l,[["render",d]]);export{p as __pageData,f as default};

View File

@ -0,0 +1 @@
import{_ as e,c as a,o as t,a4 as o}from"./chunks/framework.C3o_UkTa.js";const p=JSON.parse('{"title":"ๅผ€ๅ‘ๆŒ‡ๅ—","description":"","frontmatter":{"title":"ๅผ€ๅ‘ๆŒ‡ๅ—","order":0},"headers":[],"relativePath":"dev/guide.md","filePath":"zh/dev/guide.md","lastUpdated":1725107025000}'),l={name:"dev/guide.md"},r=o("",12),i=[r];function d(c,n,h,s,u,g){return t(),a("div",null,i)}const f=e(l,[["render",d]]);export{p as __pageData,f as default};

View File

@ -0,0 +1 @@
import{_ as e,c as t,o,a4 as a}from"./chunks/framework.C3o_UkTa.js";const m=JSON.parse('{"title":"Development Guide","description":"","frontmatter":{"title":"Development Guide","order":0},"headers":[],"relativePath":"en/dev/guide.md","filePath":"en/dev/guide.md","lastUpdated":1725107025000}'),i={name:"en/dev/guide.md"},n=a('<h1 id="development-guide" tabindex="-1">Development Guide <a class="header-anchor" href="#development-guide" aria-label="Permalink to &quot;Development Guide&quot;">โ€‹</a></h1><h2 id="how-to-develop" tabindex="-1">How to Develop <a class="header-anchor" href="#how-to-develop" aria-label="Permalink to &quot;How to Develop&quot;">โ€‹</a></h2><p>Please read the <a href="./plugin.html">Plugin Development</a> and <a href="./api/">API Reference</a> documents if you are developing a plugin.</p><p>If you need to submit code to the Liteyuki repository, please read the following:</p><ol><li>First <a href="https://github.com/LiteyukiStudio/LiteyukiBot/fork" target="_blank" rel="noreferrer">fork</a> a copy of the Liteyuki repository to your personal/organization account.</li><li>Develop in your repository.</li><li>Create a new branch in your repository and submit your code to this branch.</li><li>Create a Pull Request in your repository to merge your branch into the <code>main</code> branch of the Liteyuki repository.</li></ol><ul><li>Participation in development assumes that you are already familiar with the basic usage of the Python language and the Liteyuki framework.</li><li>If you are developing documentation, please ensure that you are familiar with Markdown syntax and basic front-end knowledge.</li><li>Contact the repository maintainer in case of conflicts.</li></ul><h3 id="suggestions" tabindex="-1">Suggestions <a class="header-anchor" href="#suggestions" aria-label="Permalink to &quot;Suggestions&quot;">โ€‹</a></h3><ul><li>During development, you can use tools such as <code>mypy</code>, <code>flake8</code>, and <code>black</code> for code checking and formatting.</li><li>Enable developer mode by setting <code>dev_mode: true</code> in <code>config.yml</code> to see more debugging information in the console.</li></ul><h2 id="standardization" tabindex="-1">Standardization <a class="header-anchor" href="#standardization" aria-label="Permalink to &quot;Standardization&quot;">โ€‹</a></h2><ul><li>Code should follow <a href="https://pep8.org/" target="_blank" rel="noreferrer"><code>PEP8</code></a> and <a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Python Style Guide</code></a>.</li><li>In addition, code submitted to the Liteyuki repository should follow the following guidelines: <ul><li>Ensure that the code is runnable and harmless.</li><li>Ensure that the type hints in the code are correct.</li><li>Ensure that the comment style is <a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Docstring</code></a> or <a href="https://github.com/LiteyukiStudio/litedoc" target="_blank" rel="noreferrer"><code>Liteyuki Docstring</code></a>(recommended) to ensure that Litedoc can parse and generate documentation correctly.</li><li>If there is a part for ordinary users, ensure that the documentation is complete (each language has corresponding documentation).</li></ul></li><li>The documentation should follow <a href="https://www.markdownguide.org/" target="_blank" rel="noreferrer"><code>Markdown</code></a> syntax and support vitepress-related content: <ul><li>Revise the documentation for each language when editing.</li><li>Ensure that the links in the document are correct and do not lead to inaccessible links.</li><li>Ensure that the <strong>User Documentation</strong> is easy to understand and the <strong>Development Documentation</strong> is detailed.</li></ul></li></ul><h2 id="finally" tabindex="-1">Finally <a class="header-anchor" href="#finally" aria-label="Permalink to &quot;Finally&quot;">โ€‹</a></h2><ul><li>This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better.</li></ul>',12),r=[n];function l(d,s,u,c,h,p){return o(),t("div",null,r)}const f=e(i,[["render",l]]);export{m as __pageData,f as default};

View File

@ -0,0 +1 @@
import{_ as e,c as t,o,a4 as a}from"./chunks/framework.C3o_UkTa.js";const m=JSON.parse('{"title":"Development Guide","description":"","frontmatter":{"title":"Development Guide","order":0},"headers":[],"relativePath":"en/dev/guide.md","filePath":"en/dev/guide.md","lastUpdated":1725107025000}'),i={name:"en/dev/guide.md"},n=a("",12),r=[n];function l(d,s,u,c,h,p){return o(),t("div",null,r)}const f=e(i,[["render",l]]);export{m as __pageData,f as default};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

26
dev/guide.html Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show More