Skip to content

Commit 185e5d4

Browse files
committed
Add DocFX documentation site with GitHub Pages deployment
Replace bloated README with concise quick-start and link to full docs. Move all detailed examples and guides into docs/articles/: - Getting Started (setup, config, DI, basic auth) - HTML & URL to PDF (Chromium features, cookies, page properties) - Screenshots (HTML/URL capture, format/quality options) - Office Conversion (LibreOffice options, image compression, watermarks) - PDF Manipulation (standalone operations, cross-cutting options) - Advanced Features (webhooks, value objects, multi-URL merge) DocFX auto-generates API reference from XML doc comments. GitHub Actions workflow deploys to GitHub Pages on push to master/develop when docs or source changes.
1 parent 24dfe86 commit 185e5d4

15 files changed

Lines changed: 925 additions & 543 deletions

.github/workflows/docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [master, develop]
6+
paths:
7+
- 'docs/**'
8+
- 'src/**/*.cs'
9+
- 'src/**/*.csproj'
10+
- '.github/workflows/docs.yml'
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: pages
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
31+
- name: Setup .NET
32+
uses: actions/setup-dotnet@v4
33+
with:
34+
dotnet-version: 8.x
35+
36+
- name: Install DocFX
37+
run: dotnet tool install -g docfx
38+
39+
- name: Build docs
40+
run: docfx docs/docfx.json
41+
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: docs/_site
46+
47+
deploy:
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
runs-on: ubuntu-latest
52+
needs: build
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)