Skip to content

Commit 52a1686

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent 7d5cda2 commit 52a1686

3 files changed

Lines changed: 20 additions & 79 deletions

File tree

.github/workflows/mkdocs.yml

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,6 @@ concurrency:
2525
cancel-in-progress: false
2626

2727
jobs:
28-
build:
29-
runs-on: ubuntu-latest
30-
steps:
31-
- name: Checkout
32-
uses: actions/checkout@v6
33-
34-
- name: Setup Pages
35-
uses: actions/configure-pages@v6
36-
37-
- name: Setup .NET
38-
uses: actions/setup-dotnet@v5
39-
with:
40-
dotnet-version: 10.0.x
41-
42-
- name: Install AutoSDK CLI
43-
run: dotnet tool install --global autosdk.cli --prerelease
44-
45-
- name: Generate docs
46-
run: autosdk docs sync .
47-
48-
- name: Build with MkDocs
49-
run: |
50-
python -m venv myenv
51-
source myenv/bin/activate
52-
pip install mkdocs-material 'pygments<2.20'
53-
mkdocs build -d ./_site
54-
55-
- name: Upload artifact
56-
uses: actions/upload-pages-artifact@v4
57-
5828
deploy:
59-
environment:
60-
name: github-pages
61-
url: ${{ steps.deployment.outputs.page_url }}
62-
runs-on: ubuntu-latest
63-
needs: build
64-
steps:
65-
- name: Deploy to GitHub Pages
66-
id: deployment
67-
uses: actions/deploy-pages@v5
29+
uses: tryAGI/workflows/.github/workflows/mkdocs-pages.yml@main
30+
secrets: inherit

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,3 +403,8 @@ FodyWeavers.xsd
403403

404404
# AutoSDK trimming check temp directory
405405
.autosdk-trim/
406+
407+
# MkDocs local build outputs
408+
site/
409+
_site/
410+
docs/assets/

mkdocs.yml

Lines changed: 13 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
site_name: Google.Gemini .NET Documentation
2+
site_description: Documentation for the tryAGI .NET SDK for Google.Gemini.
3+
site_url: https://tryagi.github.io/Google.Gemini/
4+
repo_url: https://github.com/tryAGI/Google.Gemini
5+
repo_name: tryAGI/Google.Gemini
6+
edit_uri: edit/main/docs/
27
nav:
38
- Overview: index.md
49
- Guides:
5-
- Free Tier and Image Generation: guides/free-tier-and-image-generation.md
10+
- Gemini API Free Tier: guides/free-tier-and-image-generation.md
611
- Live API (Real-time Voice/Video): guides/live-api.md
712
- Microsoft.Extensions.AI: guides/meai.md
813
# EXAMPLES:START
@@ -37,53 +42,21 @@ nav:
3742
- Speak Simple Text: examples/speak-simple-text.md
3843
- Transcribe Generated Audio: examples/transcribe-generated-audio.md
3944
# EXAMPLES:END
40-
41-
theme:
42-
name: material
43-
static_templates:
44-
- 404.html
45-
language: 'en'
46-
palette:
47-
# Palette toggle for light mode
48-
- media: "(prefers-color-scheme: light)"
49-
scheme: default
50-
primary: white
51-
accent: red
52-
toggle:
53-
icon: material/weather-sunny
54-
name: Switch to dark mode
5545

56-
# Palette toggle for dark mode
57-
- media: "(prefers-color-scheme: dark)"
58-
scheme: slate
59-
primary: blue
60-
accent: blue
61-
toggle:
62-
icon: material/weather-night
63-
name: Switch to light mode
64-
include_search_page: false
65-
search_index_only: true
46+
theme:
47+
name: tryagi
6648
favicon: 'media/icon128.png'
67-
icon:
68-
logo: 'material/file-document'
69-
features:
70-
- content.action.edit
71-
- navigation.instant
72-
font:
73-
text: 'Fira Sans'
74-
code: 'Fira Mono'
75-
76-
extra:
77-
version:
78-
provider: mike
7949

80-
extra_css:
81-
- 'css/extra.css?v=14'
50+
plugins:
51+
- search
52+
- copy-to-llm
8253

8354
markdown_extensions:
8455
- admonition
56+
- attr_list
8557
- def_list
8658
- footnotes
59+
- md_in_html
8760
- meta
8861
- toc:
8962
permalink: ""

0 commit comments

Comments
 (0)