Skip to content

Commit 594bd0c

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent d6d0402 commit 594bd0c

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
@@ -24,43 +24,6 @@ concurrency:
2424
cancel-in-progress: false
2525

2626
jobs:
27-
build:
28-
runs-on: ubuntu-latest
29-
steps:
30-
- name: Checkout
31-
uses: actions/checkout@v6
32-
33-
- name: Setup Pages
34-
uses: actions/configure-pages@v5
35-
36-
- name: Setup .NET
37-
uses: actions/setup-dotnet@v5
38-
with:
39-
dotnet-version: 10.0.x
40-
41-
- name: Install AutoSDK CLI
42-
run: dotnet tool install --global autosdk.cli --prerelease
43-
44-
- name: Generate docs
45-
run: autosdk docs sync .
46-
47-
- name: Build with MkDocs
48-
run: |
49-
python -m venv myenv
50-
source myenv/bin/activate
51-
pip install mkdocs-material 'pygments<2.20'
52-
mkdocs build -d ./_site
53-
54-
- name: Upload artifact
55-
uses: actions/upload-pages-artifact@v4
56-
5727
deploy:
58-
environment:
59-
name: github-pages
60-
url: ${{ steps.deployment.outputs.page_url }}
61-
runs-on: ubuntu-latest
62-
needs: build
63-
steps:
64-
- name: Deploy to GitHub Pages
65-
id: deployment
66-
uses: actions/deploy-pages@v4
28+
uses: tryAGI/workflows/.github/workflows/mkdocs-pages.yml@main
29+
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: AI21 .NET Documentation
2+
site_description: Documentation for the tryAGI .NET SDK for AI21.
3+
site_url: https://tryagi.github.io/AI21/
4+
repo_url: https://github.com/tryAGI/AI21
5+
repo_name: tryAGI/AI21
6+
edit_uri: edit/main/docs/
27
nav:
38
- Overview: index.md
49
- Guides:
@@ -41,53 +46,21 @@ nav:
4146
# - Bacthed executor - multi-output to one input: Examples/BatchedExecutorFork.md
4247
# - Batched executor - basic guidance: Examples/BatchedExecutorGuidance.md
4348
# - Batched executor - rewinding to an earlier state: Examples/BatchedExecutorRewind.md
44-
45-
theme:
46-
name: material
47-
static_templates:
48-
- 404.html
49-
language: 'en'
50-
palette:
51-
# Palette toggle for light mode
52-
- media: "(prefers-color-scheme: light)"
53-
scheme: default
54-
primary: white
55-
accent: red
56-
toggle:
57-
icon: material/weather-sunny
58-
name: Switch to dark mode
5949

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

84-
extra_css:
85-
- 'css/extra.css?v=14'
54+
plugins:
55+
- search
56+
- copy-to-llm
8657

8758
markdown_extensions:
8859
- admonition
60+
- attr_list
8961
- def_list
9062
- footnotes
63+
- md_in_html
9164
- meta
9265
- toc:
9366
permalink: ""
@@ -118,4 +91,4 @@ markdown_extensions:
11891
custom_checkbox: true
11992
- pymdownx.tilde
12093
- pymdownx.tabbed:
121-
alternate_style: true
94+
alternate_style: true

0 commit comments

Comments
 (0)