Skip to content

Commit c258cee

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent 0c00f7b commit c258cee

File tree

3 files changed

+19
-78
lines changed

3 files changed

+19
-78
lines changed

.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: Install .NET SDK
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
@@ -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: 12 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,28 @@
11
site_name: Humanloop .NET Documentation
2+
site_description: Documentation for the tryAGI .NET SDK for Humanloop.
3+
site_url: https://tryagi.github.io/Humanloop/
4+
repo_url: https://github.com/tryAGI/Humanloop
5+
repo_name: tryAGI/Humanloop
6+
edit_uri: edit/main/docs/
27
nav:
38
- Overview: index.md
49
# EXAMPLES:START
510
# EXAMPLES:END
6-
7-
theme:
8-
name: material
9-
static_templates:
10-
- 404.html
11-
language: 'en'
12-
palette:
13-
# Palette toggle for light mode
14-
- media: "(prefers-color-scheme: light)"
15-
scheme: default
16-
primary: white
17-
accent: red
18-
toggle:
19-
icon: material/weather-sunny
20-
name: Switch to dark mode
2111

22-
# Palette toggle for dark mode
23-
- media: "(prefers-color-scheme: dark)"
24-
scheme: slate
25-
primary: blue
26-
accent: blue
27-
toggle:
28-
icon: material/weather-night
29-
name: Switch to light mode
30-
include_search_page: false
31-
search_index_only: true
12+
theme:
13+
name: tryagi
3214
favicon: 'media/icon128.png'
33-
icon:
34-
logo: 'material/file-document'
35-
features:
36-
- content.action.edit
37-
- navigation.instant
38-
font:
39-
text: 'Fira Sans'
40-
code: 'Fira Mono'
41-
42-
extra:
43-
version:
44-
provider: mike
4515

46-
extra_css:
47-
- 'css/extra.css?v=14'
16+
plugins:
17+
- search
18+
- copy-to-llm
4819

4920
markdown_extensions:
5021
- admonition
22+
- attr_list
5123
- def_list
5224
- footnotes
25+
- md_in_html
5326
- meta
5427
- toc:
5528
permalink: ""

0 commit comments

Comments
 (0)