Skip to content

Commit cd16d53

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent 6d835c3 commit cd16d53

3 files changed

Lines changed: 19 additions & 78 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@v5
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,58 +1,31 @@
11
site_name: Roboflow .NET Documentation
2+
site_description: Documentation for the tryAGI .NET SDK for Roboflow.
3+
site_url: https://tryagi.github.io/Roboflow/
4+
repo_url: https://github.com/tryAGI/Roboflow
5+
repo_name: tryAGI/Roboflow
6+
edit_uri: edit/main/docs/
27
nav:
38
- Overview: index.md
49
- Guides:
510
- Authentication: guides/authentication.md
611
- MEAI Integration: guides/meai.md
712
# EXAMPLES:START
813
# EXAMPLES:END
9-
10-
theme:
11-
name: material
12-
static_templates:
13-
- 404.html
14-
language: 'en'
15-
palette:
16-
# Palette toggle for light mode
17-
- media: "(prefers-color-scheme: light)"
18-
scheme: default
19-
primary: white
20-
accent: red
21-
toggle:
22-
icon: material/weather-sunny
23-
name: Switch to dark mode
2414

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

49-
extra_css:
50-
- 'css/extra.css?v=14'
19+
plugins:
20+
- search
21+
- copy-to-llm
5122

5223
markdown_extensions:
5324
- admonition
25+
- attr_list
5426
- def_list
5527
- footnotes
28+
- md_in_html
5629
- meta
5730
- toc:
5831
permalink: ""

0 commit comments

Comments
 (0)