Skip to content

Commit 53cedda

Browse files
committed
Docs configuration
1 parent 729e688 commit 53cedda

File tree

7 files changed

+109
-0
lines changed

7 files changed

+109
-0
lines changed

.github/workflows/docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
7+
permissions:
8+
actions: read
9+
pages: write
10+
id-token: write
11+
12+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
13+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
publish-docs:
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v3
27+
28+
- name: .NET Setup
29+
uses: actions/setup-dotnet@v3
30+
with:
31+
dotnet-version: 9.x
32+
33+
- run: dotnet tool update -g docfx
34+
35+
- run: docfx docs/docfx.json
36+
37+
- name: Upload Pages artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: 'docs/_site'
41+
42+
- name: Deploy to GitHub Pages
43+
id: deployment
44+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,7 @@ _NCrunch_*
7373
nCrunchTemp_*
7474

7575
*.orig
76+
77+
# Auto-generated documentation
78+
docs/_site
79+
docs/api

docs/docfx.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
3+
"metadata": [
4+
{
5+
"src": [
6+
{
7+
"src": "../src",
8+
"files": [
9+
"**/*.csproj"
10+
]
11+
}
12+
],
13+
"dest": "api"
14+
}
15+
],
16+
"build": {
17+
"content": [
18+
{
19+
"files": [
20+
"**/*.{md,yml}"
21+
],
22+
"exclude": [
23+
"_site/**"
24+
]
25+
}
26+
],
27+
"resource": [
28+
{
29+
"files": [
30+
"images/**"
31+
]
32+
}
33+
],
34+
"output": "_site",
35+
"template": [
36+
"default",
37+
"modern"
38+
],
39+
"globalMetadata": {
40+
"_appName": "MCP .NET SDK",
41+
"_appTitle": "MCP .NET SDK",
42+
"_enableSearch": true,
43+
"pdf": true,
44+
"_appLogoPath": "images/logo.png",
45+
"_appFaviconPath": "images/favicon.ico"
46+
}
47+
}
48+
}

docs/images/favicon.ico

15 KB
Binary file not shown.

docs/images/logo.png

1.32 KB
Loading

docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
_layout: landing
3+
---
4+
5+
# Model Context Protocol (MCP) .NET SDK
6+
7+
Welcome to the API documentation for the MCP .NET SDK. [Explore the API](https://aka.ms/mcp/dotnet).
8+
9+
For how-to guides, tutorials, and additional guidance, refer to the [official MCP documentation](https://modelcontextprotocol.io/).

docs/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- name: Home
2+
href: /index
3+
- name: API Docs
4+
href: api/

0 commit comments

Comments
 (0)