Skip to content

Commit 487f383

Browse files
kaolayukaolayu
committed
docs: rebuild documentation and examples
1 parent 9fea873 commit 487f383

13 files changed

Lines changed: 25 additions & 22 deletions

File tree

‎docs/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</head>
1717
<body>
1818
<div id="app"></div>
19-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_core.md\":\"Cc8yXDWX\",\"guide_getting-started.md\":\"DHkwaTj3\",\"guide_visual-editor.md\":\"EVAEXtWy\",\"guide_what-is-soonfx.md\":\"C7JFj7Zu\",\"index.md\":\"DwbxCa3D\",\"zh_api_core.md\":\"BymU-0hY\",\"zh_guide_getting-started.md\":\"CuJhUNse\",\"zh_guide_visual-editor.md\":\"B8rfKyG_\",\"zh_guide_what-is-soonfx.md\":\"DlzmNWX2\",\"zh_index.md\":\"DoWiB2gR\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/logo.svg\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/soonfx-engine/core\"}],\"footer\":{\"message\":\"Released under the Apache-2.0 License.\",\"copyright\":\"Copyright © 2024-present SoonFx Team\"}},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/core\"},{\"text\":\"Examples\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is SoonFx?\",\"link\":\"/guide/what-is-soonfx\"},{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"Core Concepts\",\"items\":[{\"text\":\"Visual Editor\",\"link\":\"/guide/visual-editor\"}]}]}},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"link\":\"/zh/\",\"title\":\"SoonFx\",\"description\":\"TypeScript 优先的游戏数值引擎\",\"themeConfig\":{\"nav\":[{\"text\":\"指南\",\"link\":\"/zh/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/zh/api/core\"},{\"text\":\"示例\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 SoonFx?\",\"link\":\"/zh/guide/what-is-soonfx\"},{\"text\":\"快速开始\",\"link\":\"/zh/guide/getting-started\"}]},{\"text\":\"核心概念\",\"items\":[{\"text\":\"可视化编辑器\",\"link\":\"/zh/guide/visual-editor\"}]}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"lastUpdated\":{\"text\":\"最后更新于\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"深色模式\"}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
19+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_core.md\":\"Cc8yXDWX\",\"guide_getting-started.md\":\"DHkwaTj3\",\"guide_visual-editor.md\":\"EVAEXtWy\",\"guide_what-is-soonfx.md\":\"C7JFj7Zu\",\"index.md\":\"DwbxCa3D\",\"zh_api_core.md\":\"BymU-0hY\",\"zh_guide_getting-started.md\":\"CuJhUNse\",\"zh_guide_visual-editor.md\":\"B8rfKyG_\",\"zh_guide_what-is-soonfx.md\":\"DlzmNWX2\",\"zh_index.md\":\"DoWiB2gR\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/logo.svg\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/soonfx-engine/core\"}],\"footer\":{\"message\":\"Released under the Apache-2.0 License.\",\"copyright\":\"Copyright © 2025-present SoonFx Team\"}},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/core\"},{\"text\":\"Examples\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is SoonFx?\",\"link\":\"/guide/what-is-soonfx\"},{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"Core Concepts\",\"items\":[{\"text\":\"Visual Editor\",\"link\":\"/guide/visual-editor\"}]}]}},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"link\":\"/zh/\",\"title\":\"SoonFx\",\"description\":\"TypeScript 优先的游戏数值引擎\",\"themeConfig\":{\"nav\":[{\"text\":\"指南\",\"link\":\"/zh/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/zh/api/core\"},{\"text\":\"示例\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 SoonFx?\",\"link\":\"/zh/guide/what-is-soonfx\"},{\"text\":\"快速开始\",\"link\":\"/zh/guide/getting-started\"}]},{\"text\":\"核心概念\",\"items\":[{\"text\":\"可视化编辑器\",\"link\":\"/zh/guide/visual-editor\"}]}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"lastUpdated\":{\"text\":\"最后更新于\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"深色模式\"}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
2020

2121
</body>
2222
</html>

‎docs/api/core.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/examples/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -779,6 +779,9 @@
779779
<!-- Header -->
780780
<div class="header">
781781
<div class="header-btns">
782+
<a href="https://soonfx.dev" class="github-btn" title="SoonFx Documentation">
783+
<span>📚 Docs</span>
784+
</a>
782785
<a href="https://github.com/soonfx-engine/core" target="_blank" class="github-btn" title="GitHub Repository">
783786
<svg viewBox="0 0 16 16" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/></svg>
784787
<span>GitHub</span>

‎docs/guide/getting-started.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// const configData = await fetch(&#39;path/to/config.json&#39;).then(res =&gt; res.json());</span></span>
3737
<span class="line"></span>
3838
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// Initialize systems with data (Conceptual)</span></span>
39-
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ...</span></span></code></pre></div><p><em>Detailed guide on loading editor data coming soon.</em></p><h2 id="next-steps" tabindex="-1">Next Steps <a class="header-anchor" href="#next-steps" aria-label="Permalink to &quot;Next Steps&quot;">​</a></h2><ul><li>Explore the <a href="/guide/visual-editor.html">Visual Editor</a> workflow.</li><li>Check the <a href="/api/core.html">API Reference</a> for detailed class documentation.</li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/guide/what-is-soonfx.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>What is SoonFx?</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/guide/visual-editor.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Visual Editor</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5d98c3a5 data-v-e315a0ad><div class="container" data-v-e315a0ad><p class="message" data-v-e315a0ad>Released under the Apache-2.0 License.</p><p class="copyright" data-v-e315a0ad>Copyright © 2024-present SoonFx Team</p></div></footer><!--[--><!--]--></div></div>
40-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_core.md\":\"Cc8yXDWX\",\"guide_getting-started.md\":\"DHkwaTj3\",\"guide_visual-editor.md\":\"EVAEXtWy\",\"guide_what-is-soonfx.md\":\"C7JFj7Zu\",\"index.md\":\"DwbxCa3D\",\"zh_api_core.md\":\"BymU-0hY\",\"zh_guide_getting-started.md\":\"CuJhUNse\",\"zh_guide_visual-editor.md\":\"B8rfKyG_\",\"zh_guide_what-is-soonfx.md\":\"DlzmNWX2\",\"zh_index.md\":\"DoWiB2gR\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/logo.svg\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/soonfx-engine/core\"}],\"footer\":{\"message\":\"Released under the Apache-2.0 License.\",\"copyright\":\"Copyright © 2024-present SoonFx Team\"}},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/core\"},{\"text\":\"Examples\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is SoonFx?\",\"link\":\"/guide/what-is-soonfx\"},{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"Core Concepts\",\"items\":[{\"text\":\"Visual Editor\",\"link\":\"/guide/visual-editor\"}]}]}},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"link\":\"/zh/\",\"title\":\"SoonFx\",\"description\":\"TypeScript 优先的游戏数值引擎\",\"themeConfig\":{\"nav\":[{\"text\":\"指南\",\"link\":\"/zh/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/zh/api/core\"},{\"text\":\"示例\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 SoonFx?\",\"link\":\"/zh/guide/what-is-soonfx\"},{\"text\":\"快速开始\",\"link\":\"/zh/guide/getting-started\"}]},{\"text\":\"核心概念\",\"items\":[{\"text\":\"可视化编辑器\",\"link\":\"/zh/guide/visual-editor\"}]}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"lastUpdated\":{\"text\":\"最后更新于\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"深色模式\"}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
39+
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ...</span></span></code></pre></div><p><em>Detailed guide on loading editor data coming soon.</em></p><h2 id="next-steps" tabindex="-1">Next Steps <a class="header-anchor" href="#next-steps" aria-label="Permalink to &quot;Next Steps&quot;">​</a></h2><ul><li>Explore the <a href="/guide/visual-editor.html">Visual Editor</a> workflow.</li><li>Check the <a href="/api/core.html">API Reference</a> for detailed class documentation.</li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/guide/what-is-soonfx.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>What is SoonFx?</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/guide/visual-editor.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Visual Editor</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5d98c3a5 data-v-e315a0ad><div class="container" data-v-e315a0ad><p class="message" data-v-e315a0ad>Released under the Apache-2.0 License.</p><p class="copyright" data-v-e315a0ad>Copyright © 2025-present SoonFx Team</p></div></footer><!--[--><!--]--></div></div>
40+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_core.md\":\"Cc8yXDWX\",\"guide_getting-started.md\":\"DHkwaTj3\",\"guide_visual-editor.md\":\"EVAEXtWy\",\"guide_what-is-soonfx.md\":\"C7JFj7Zu\",\"index.md\":\"DwbxCa3D\",\"zh_api_core.md\":\"BymU-0hY\",\"zh_guide_getting-started.md\":\"CuJhUNse\",\"zh_guide_visual-editor.md\":\"B8rfKyG_\",\"zh_guide_what-is-soonfx.md\":\"DlzmNWX2\",\"zh_index.md\":\"DoWiB2gR\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"/logo.svg\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/soonfx-engine/core\"}],\"footer\":{\"message\":\"Released under the Apache-2.0 License.\",\"copyright\":\"Copyright © 2025-present SoonFx Team\"}},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\",\"title\":\"SoonFx\",\"description\":\"The TypeScript-first numeric engine for games.\",\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/core\"},{\"text\":\"Examples\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is SoonFx?\",\"link\":\"/guide/what-is-soonfx\"},{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"Core Concepts\",\"items\":[{\"text\":\"Visual Editor\",\"link\":\"/guide/visual-editor\"}]}]}},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"link\":\"/zh/\",\"title\":\"SoonFx\",\"description\":\"TypeScript 优先的游戏数值引擎\",\"themeConfig\":{\"nav\":[{\"text\":\"指南\",\"link\":\"/zh/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/zh/api/core\"},{\"text\":\"示例\",\"link\":\"https://soonfx.dev/examples\"}],\"sidebar\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 SoonFx?\",\"link\":\"/zh/guide/what-is-soonfx\"},{\"text\":\"快速开始\",\"link\":\"/zh/guide/getting-started\"}]},{\"text\":\"核心概念\",\"items\":[{\"text\":\"可视化编辑器\",\"link\":\"/zh/guide/visual-editor\"}]}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"lastUpdated\":{\"text\":\"最后更新于\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"深色模式\"}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
4141

4242
</body>
4343
</html>

0 commit comments

Comments
 (0)