Skip to content

Commit c8d1b7c

Browse files
committed
chore(docs): adopt shared mkdocs theme and workflow
1 parent 7c61ff4 commit c8d1b7c

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
@@ -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@v6
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@v5
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
@@ -402,3 +402,8 @@ FodyWeavers.xsd
402402

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

mkdocs.yml

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

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

51-
extra_css:
52-
- 'css/extra.css?v=14'
21+
plugins:
22+
- search
23+
- copy-to-llm
5324

5425
markdown_extensions:
5526
- admonition
27+
- attr_list
5628
- def_list
5729
- footnotes
30+
- md_in_html
5831
- meta
5932
- toc:
6033
permalink: ""

0 commit comments

Comments
 (0)