Skip to content

Commit 205461e

Browse files
tmgbedutmgbedu
committed
feat: deployment fix
1 parent 269f19c commit 205461e

42 files changed

Lines changed: 624 additions & 10 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,60 @@ name: Deploy VitePress site to Pages
22

33
on:
44
push:
5-
branches: [ "main" ]
5+
branches: [ main ]
6+
7+
# Allows you to run this workflow manually from the Actions tab
68
workflow_dispatch:
79

10+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
811
permissions:
912
contents: read
1013
pages: write
1114
id-token: write
1215

16+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
17+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
1318
concurrency:
14-
group: "pages"
19+
group: pages
1520
cancel-in-progress: false
1621

1722
jobs:
23+
# Build job
1824
build:
1925
runs-on: ubuntu-latest
2026
steps:
2127
- name: Checkout
22-
uses: actions/checkout@v4
28+
uses: actions/checkout@v5
2329
with:
24-
fetch-depth: 0
30+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
31+
# - uses: pnpm/action-setup@v4 # Uncomment this block if you're using pnpm
32+
# with:
33+
# version: 9 # Not needed if you've set "packageManager" in package.json
34+
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
2535
- name: Setup Node
26-
uses: actions/setup-node@v4
36+
uses: actions/setup-node@v6
2737
with:
28-
node-version: 20
29-
cache: npm
38+
node-version: 24
39+
cache: npm # or pnpm / yarn
3040
- name: Setup Pages
3141
uses: actions/configure-pages@v4
3242
- name: Install dependencies
33-
run: npm install
43+
run: npm ci # or pnpm install / yarn install / bun install
3444
- name: Build with VitePress
35-
run: npm run docs:build
45+
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
3646
- name: Upload artifact
3747
uses: actions/upload-pages-artifact@v3
3848
with:
3949
path: .vitepress/dist
4050

51+
# Deployment job
4152
deploy:
4253
environment:
4354
name: github-pages
4455
url: ${{ steps.deployment.outputs.page_url }}
4556
needs: build
4657
runs-on: ubuntu-latest
58+
name: Deploy
4759
steps:
4860
- name: Deploy to GitHub Pages
4961
id: deployment

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
.idea
22
node_modules
3-
.vitepress/dist

‎.vitepress/dist/404.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US" dir="ltr">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width,initial-scale=1">
6+
<title>404 | FastAPI Starter Kit</title>
7+
<meta name="description" content="Not Found">
8+
<meta name="generator" content="VitePress v2.0.0-alpha.17">
9+
<link rel="preload stylesheet" href="/assets/style.Bv8hHPNp.css" as="style">
10+
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
11+
12+
<script type="module" src="/assets/app.CI8cmM83.js"></script>
13+
<link rel="preload" href="/assets/inter-roman-latin.Cy4MYw_J.woff2" as="font" type="font/woff2" crossorigin="">
14+
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
15+
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
16+
</head>
17+
<body>
18+
<div id="app"></div>
19+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"docs_console.md\":\"DzAk-KzT\",\"docs_fastapi.md\":\"Dq5dDec-\",\"docs_getting-started.md\":\"BkZxk8jM\",\"docs_logging.md\":\"C5y0PLRx\",\"index.md\":\"D5xtG36p\",\"readme.md\":\"pH5nl2oa\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"FastAPI Starter Kit\",\"description\":\"A repositories of components that can used inside fastapi or console applications\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Documentation\",\"link\":\"/docs/getting-started\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/docs/getting-started\"},{\"text\":\"FastAPI\",\"link\":\"/docs/fastapi\"},{\"text\":\"Logging\",\"link\":\"/docs/logging\"},{\"text\":\"Console Commands\",\"link\":\"/docs/console\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/fastapi-startkit/fastapi_startkit\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false,\"additionalConfig\":{}}");</script>
20+
21+
</body>
22+
</html>

‎.vitepress/dist/README.html‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US" dir="ltr">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width,initial-scale=1">
6+
<title>FastAPI Starter Kit Documentation | FastAPI Starter Kit</title>
7+
<meta name="description" content="A repositories of components that can used inside fastapi or console applications">
8+
<meta name="generator" content="VitePress v2.0.0-alpha.17">
9+
<link rel="preload stylesheet" href="/assets/style.Bv8hHPNp.css" as="style">
10+
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
11+
12+
<script type="module" src="/assets/app.CI8cmM83.js"></script>
13+
<link rel="preload" href="/assets/inter-roman-latin.Cy4MYw_J.woff2" as="font" type="font/woff2" crossorigin="">
14+
<link rel="modulepreload" href="/assets/chunks/theme.CEG6_krx.js">
15+
<link rel="modulepreload" href="/assets/chunks/framework.B3x_xFnx.js">
16+
<link rel="modulepreload" href="/assets/README.md.pH5nl2oa.lean.js">
17+
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
18+
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
19+
</head>
20+
<body>
21+
<div id="app"><div class="Layout" data-v-c109192d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-10d4d845></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-10d4d845>Skip to content</a><!--]--><!----><header class="VPNav" data-v-c109192d data-v-d5bf7c8e><div class="VPNavBar has-sidebar top" data-v-d5bf7c8e data-v-cc1d9f2e><div class="wrapper" data-v-cc1d9f2e><div class="container" data-v-cc1d9f2e><div class="title" data-v-cc1d9f2e><div class="VPNavBarTitle has-sidebar" data-v-cc1d9f2e data-v-d4488dd0><a class="title" href="/" data-v-d4488dd0><!--[--><!--]--><!----><span data-v-d4488dd0>FastAPI Starter Kit</span><!--[--><!--]--></a></div></div><div class="content" data-v-cc1d9f2e><div class="content-body" data-v-cc1d9f2e><!--[--><!--]--><div class="VPNavBarSearch search" data-v-cc1d9f2e data-v-bdd98725><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-cc1d9f2e data-v-020be4db><span id="main-nav-aria-label" class="visually-hidden" data-v-020be4db> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-020be4db data-v-727dd4ba><!--[--><span data-v-727dd4ba>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/getting-started.html" tabindex="0" data-v-020be4db data-v-727dd4ba><!--[--><span data-v-727dd4ba>Documentation</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-cc1d9f2e data-v-3f90c1a5><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-3f90c1a5 data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-cc1d9f2e data-v-ef6192dc data-v-a1a7286e><!--[--><a class="VPSocialLink no-icon" href="https://github.com/fastapi-startkit/fastapi_startkit" aria-label="github" target="_blank" rel="me noopener" data-v-a1a7286e data-v-32d78712><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-cc1d9f2e data-v-2a0cad91 data-v-d8fae6e2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-d8fae6e2><span class="vpi-more-horizontal icon" data-v-d8fae6e2></span></button><div class="menu" data-v-d8fae6e2><div class="VPMenu" data-v-d8fae6e2 data-v-fcd1d7a8><!----><!--[--><!--[--><!----><div class="group" data-v-2a0cad91><div class="item appearance" data-v-2a0cad91><p class="label" data-v-2a0cad91>Appearance</p><div class="appearance-action" data-v-2a0cad91><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-2a0cad91 data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div></div></div><div class="group" data-v-2a0cad91><div class="item social-links" data-v-2a0cad91><div class="VPSocialLinks social-links-list" data-v-2a0cad91 data-v-a1a7286e><!--[--><a class="VPSocialLink no-icon" href="https://github.com/fastapi-startkit/fastapi_startkit" aria-label="github" target="_blank" rel="me noopener" data-v-a1a7286e data-v-32d78712><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-cc1d9f2e data-v-6bee1efd><span class="container" data-v-6bee1efd><span class="top" data-v-6bee1efd></span><span class="middle" data-v-6bee1efd></span><span class="bottom" data-v-6bee1efd></span></span></button></div></div></div></div><div class="divider" data-v-cc1d9f2e><div class="divider-line" data-v-cc1d9f2e></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-c109192d data-v-73add737><div class="container" data-v-73add737><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-73add737><span class="vpi-align-left menu-icon" data-v-73add737></span><span class="menu-text" data-v-73add737>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-73add737 data-v-e28a51a6><button data-v-e28a51a6>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-c109192d data-v-49f51a23><div class="curtain" data-v-49f51a23></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-49f51a23><span class="visually-hidden" id="sidebar-aria-label" data-v-49f51a23> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-a84b7c21><section class="VPSidebarItem level-0" data-v-a84b7c21 data-v-6b36a2fd><div class="item" role="button" tabindex="0" data-v-6b36a2fd><div class="indicator" data-v-6b36a2fd></div><h2 class="text" data-v-6b36a2fd>Guide</h2><!----></div><div class="items" data-v-6b36a2fd><!--[--><div class="VPSidebarItem level-1 is-link" data-v-6b36a2fd data-v-6b36a2fd><div class="item" data-v-6b36a2fd><div class="indicator" data-v-6b36a2fd></div><a class="VPLink link link" href="/docs/getting-started.html" data-v-6b36a2fd><!--[--><p class="text" data-v-6b36a2fd>Getting Started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-6b36a2fd data-v-6b36a2fd><div class="item" data-v-6b36a2fd><div class="indicator" data-v-6b36a2fd></div><a class="VPLink link link" href="/docs/fastapi.html" data-v-6b36a2fd><!--[--><p class="text" data-v-6b36a2fd>FastAPI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-6b36a2fd data-v-6b36a2fd><div class="item" data-v-6b36a2fd><div class="indicator" data-v-6b36a2fd></div><a class="VPLink link link" href="/docs/logging.html" data-v-6b36a2fd><!--[--><p class="text" data-v-6b36a2fd>Logging</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-6b36a2fd data-v-6b36a2fd><div class="item" data-v-6b36a2fd><div class="indicator" data-v-6b36a2fd></div><a class="VPLink link link" href="/docs/console.html" data-v-6b36a2fd><!--[--><p class="text" data-v-6b36a2fd>Console Commands</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-c109192d data-v-529a4999><div class="VPDoc has-sidebar has-aside" data-v-529a4999 data-v-d668f7cc><!--[--><!--]--><div class="container" data-v-d668f7cc><div class="aside" data-v-d668f7cc><div class="aside-curtain" data-v-d668f7cc></div><div class="aside-container" data-v-d668f7cc><div class="aside-content" data-v-d668f7cc><div class="VPDocAside" data-v-d668f7cc data-v-cb998dce><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-cb998dce data-v-c8b19031><div class="content" data-v-c8b19031><div class="outline-marker" data-v-c8b19031></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-c8b19031>On this page</div><ul class="VPDocOutlineItem root" data-v-c8b19031 data-v-63c57e50><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-cb998dce></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-d668f7cc><div class="content-container" data-v-d668f7cc><!--[--><!--]--><main class="main" data-v-d668f7cc><div style="position:relative;" class="vp-doc _README" data-v-d668f7cc><div><h1 id="fastapi-starter-kit-documentation" tabindex="-1">FastAPI Starter Kit Documentation <a class="header-anchor" href="#fastapi-starter-kit-documentation" aria-label="Permalink to “FastAPI Starter Kit Documentation”">​</a></h1><p>This repository contains the source code for the documentation site of the <strong>FastAPI Starter Kit</strong>, accessible at <a href="https://fastapi-startkit.github.io/" target="_blank" rel="noreferrer">fastapi-startkit.github.io</a>.</p><p>The documentation is built using <a href="https://vitepress.dev/" target="_blank" rel="noreferrer">VitePress</a>, a Vite-native documentation framework.</p><h2 id="🚀-development" tabindex="-1">🚀 Development <a class="header-anchor" href="#🚀-development" aria-label="Permalink to “🚀 Development”">​</a></h2><p>To run the documentation site locally for development:</p><div class="language-bash"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Install dependencies</span></span>
22+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span></span>
23+
<span class="line"></span>
24+
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Start local development server</span></span>
25+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs:dev</span></span></code></pre></div><h2 id="🏗️-build-and-deployment" tabindex="-1">🏗️ Build and Deployment <a class="header-anchor" href="#🏗️-build-and-deployment" aria-label="Permalink to “🏗️ Build and Deployment”">​</a></h2><p>The site is automatically built and deployed to GitHub Pages using <strong>GitHub Actions</strong>.</p><ul><li><strong>Workflow</strong>: <a href=".github/workflows/deploy.yml">.github/workflows/deploy.yml</a></li><li><strong>Automatic Deployment</strong>: Any push to the <code>main</code> branch triggers a new build and deployment.</li></ul><h2 id="📁-repository-structure" tabindex="-1">📁 Repository Structure <a class="header-anchor" href="#📁-repository-structure" aria-label="Permalink to “📁 Repository Structure”">​</a></h2><ul><li><code>docs/</code>: Contains the Markdown files for the documentation.</li><li><code>.vitepress/</code>: VitePress configuration and theme customizations.</li><li><code>index.md</code>: The landing page of the documentation site.</li></ul></div></div></main><footer class="VPDocFooter" data-v-d668f7cc data-v-1bcd8184><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-1bcd8184><span class="visually-hidden" id="doc-footer-aria-label" data-v-1bcd8184>Pager</span><div class="pager" data-v-1bcd8184><!----></div><div class="pager" data-v-1bcd8184><a class="VPLink link pager-link next" href="/docs/getting-started.html" data-v-1bcd8184><!--[--><span class="desc" data-v-1bcd8184>Next page</span><span class="title" data-v-1bcd8184>Getting Started</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
26+
<script>window.__VP_HASH_MAP__=JSON.parse("{\"docs_console.md\":\"DzAk-KzT\",\"docs_fastapi.md\":\"Dq5dDec-\",\"docs_getting-started.md\":\"BkZxk8jM\",\"docs_logging.md\":\"C5y0PLRx\",\"index.md\":\"D5xtG36p\",\"readme.md\":\"pH5nl2oa\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"FastAPI Starter Kit\",\"description\":\"A repositories of components that can used inside fastapi or console applications\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Documentation\",\"link\":\"/docs/getting-started\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/docs/getting-started\"},{\"text\":\"FastAPI\",\"link\":\"/docs/fastapi\"},{\"text\":\"Logging\",\"link\":\"/docs/logging\"},{\"text\":\"Console Commands\",\"link\":\"/docs/console\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/fastapi-startkit/fastapi_startkit\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false,\"additionalConfig\":{}}");</script>
27+
28+
</body>
29+
</html>

0 commit comments

Comments
 (0)