Skip to content

Commit 320b44e

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent f7ff37d commit 320b44e

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
@@ -26,43 +26,6 @@ concurrency:
2626
cancel-in-progress: false
2727

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

.gitignore

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

401401
# AutoSDK trimming check temp directory
402402
.autosdk-trim/
403+
404+
# MkDocs local build outputs
405+
site/
406+
_site/
407+
docs/assets/

mkdocs.yml

Lines changed: 13 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
site_name: Groq .NET Documentation
2+
site_description: Documentation for the tryAGI .NET SDK for Groq.
3+
site_url: https://tryagi.github.io/Groq/
4+
repo_url: https://github.com/tryAGI/Groq
5+
repo_name: tryAGI/Groq
6+
edit_uri: edit/main/docs/
27
nav:
38
- Overview: index.md
49
# EXAMPLES:START
@@ -10,53 +15,21 @@ nav:
1015
- Files: examples/files.md
1116
- Batches: examples/batches.md
1217
# EXAMPLES:END
13-
14-
theme:
15-
name: material
16-
static_templates:
17-
- 404.html
18-
language: 'en'
19-
palette:
20-
# Palette toggle for light mode
21-
- media: "(prefers-color-scheme: light)"
22-
scheme: default
23-
primary: white
24-
accent: red
25-
toggle:
26-
icon: material/weather-sunny
27-
name: Switch to dark mode
2818

29-
# Palette toggle for dark mode
30-
- media: "(prefers-color-scheme: dark)"
31-
scheme: slate
32-
primary: blue
33-
accent: blue
34-
toggle:
35-
icon: material/weather-night
36-
name: Switch to light mode
37-
include_search_page: false
38-
search_index_only: true
19+
theme:
20+
name: tryagi
3921
favicon: 'media/icon128.png'
40-
icon:
41-
logo: 'material/file-document'
42-
features:
43-
- content.action.edit
44-
- navigation.instant
45-
font:
46-
text: 'Fira Sans'
47-
code: 'Fira Mono'
48-
49-
extra:
50-
version:
51-
provider: mike
5222

53-
extra_css:
54-
- 'css/extra.css?v=14'
23+
plugins:
24+
- search
25+
- copy-to-llm
5526

5627
markdown_extensions:
5728
- admonition
29+
- attr_list
5830
- def_list
5931
- footnotes
32+
- md_in_html
6033
- meta
6134
- toc:
6235
permalink: ""
@@ -87,4 +60,4 @@ markdown_extensions:
8760
custom_checkbox: true
8861
- pymdownx.tilde
8962
- pymdownx.tabbed:
90-
alternate_style: true
63+
alternate_style: true

0 commit comments

Comments
 (0)