Merge pull request #77 from ChangemakerStudios/feature/docfx-documentation

Switch from DocFX to MkDocs Material for documentation

Author: Jaben

.github/workflows/docs.yml

@@ -5,8 +5,7 @@ on:
     branches: [master, develop]
     paths:
       - 'docs/**'
-      - 'src/**/*.cs'
-      - 'src/**/*.csproj'
+      - 'mkdocs.yml'
       - '.github/workflows/docs.yml'
   workflow_dispatch:
 
@@ -28,21 +27,21 @@ jobs:
       with:
         fetch-depth: 0
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v4
+    - name: Setup Python
+      uses: actions/setup-python@v5
       with:
-        dotnet-version: 8.x
+        python-version: '3.x'
 
-    - name: Install DocFX
-      run: dotnet tool install -g docfx
+    - name: Install MkDocs Material
+      run: pip install mkdocs-material
 
     - name: Build docs
-      run: docfx docs/docfx.json
+      run: mkdocs build --strict
 
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v3
       with:
-        path: docs/_site
+        path: site
 
   deploy:
     environment:

.gitignore

@@ -290,3 +290,4 @@ __pycache__/
 
 settings.local.json
 examples/**/output
+site/

docs/.gitignore

@@ -1,6 +1 @@
-_site/
-api/.manifest
-api/*.yml
-api/*.md
-!api/index.md
-obj/
+

docs/articles/advanced-features.md docs/advanced-features.mddocs/articles/advanced-features.md renamed to docs/advanced-features.md

@@ -1,6 +1,9 @@
 # Advanced Features
 
-> **Examples:** [Webhook](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/Webhook), [UrlsToMergedPdf](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/UrlsToMergedPdf), [DIExample](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/DIExample)
+!!! example "Working Examples"
+    [Webhook](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/Webhook) |
+    [UrlsToMergedPdf](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/UrlsToMergedPdf) |
+    [DIExample](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/DIExample)
 
 ## Webhooks
 

docs/api/index.md

@@ -1,6 +1,7 @@
 # Getting Started
 
-> **Example:** [DIExample](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/DIExample) — Full DI setup with logging and Polly retry
+!!! example "Working Example"
+    [DIExample](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/DIExample) — Full DI setup with logging and Polly retry
 
 ## Prerequisites
 

docs/articles/toc.yml

@@ -1,6 +1,10 @@
 # HTML & URL to PDF
 
-> **Examples:** [HtmlConvert](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/HtmlConvert), [UrlConvert](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/UrlConvert), [HtmlWithMarkdown](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/HtmlWithMarkdown), [ChromiumFeatures](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/ChromiumFeatures)
+!!! example "Working Examples"
+    [HtmlConvert](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/HtmlConvert) |
+    [UrlConvert](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/UrlConvert) |
+    [HtmlWithMarkdown](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/HtmlWithMarkdown) |
+    [ChromiumFeatures](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/tree/develop/examples/ChromiumFeatures)
 
 ## HTML to PDF
 

docs/docfx.json

@@ -1,11 +1,11 @@
----
-_layout: landing
----
-
 # GotenbergSharpApiClient
 
 .NET C# client for [Gotenberg](https://gotenberg.dev/) — a Docker-powered stateless API for converting & merging HTML, Markdown, and Office documents to PDF.
 
+[![NuGet version](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client.svg)](https://badge.fury.io/nu/Gotenberg.Sharp.Api.Client)
+[![Downloads](https://img.shields.io/nuget/dt/Gotenberg.Sharp.API.Client.svg?logo=nuget&color=purple)](https://www.nuget.org/packages/Gotenberg.Sharp.API.Client)
+![Build status](https://github.com/ChangemakerStudios/GotenbergSharpApiClient/actions/workflows/deploy.yml/badge.svg)
+
 ## Features
 
 - **HTML/URL to PDF** — Convert HTML content or URLs to PDF using Chromium
@@ -19,16 +19,22 @@ _layout: landing
 
 ## Quick Start
 
+### Install
+
 ```bash
 dotnet add package Gotenberg.Sharp.Api.Client
 ```
 
+### Configure
+
 ```csharp
 services.AddOptions<GotenbergSharpClientOptions>()
     .Bind(Configuration.GetSection("GotenbergSharpClient"));
 services.AddGotenbergSharpClient();
 ```
 
+### Use
+
 ```csharp
 var builder = new HtmlRequestBuilder()
     .AddDocument(doc => doc.SetBody("<html><body><h1>Hello PDF!</h1></body></html>"))
@@ -37,12 +43,4 @@ var builder = new HtmlRequestBuilder()
 var result = await sharpClient.HtmlToPdfAsync(builder);
 ```
 
-## Documentation
-
-- [Getting Started](articles/getting-started.md)
-- [HTML & URL to PDF](articles/html-and-url-to-pdf.md)
-- [Screenshots](articles/screenshots.md)
-- [Office Document Conversion](articles/office-conversion.md)
-- [PDF Manipulation](articles/pdf-manipulation.md)
-- [Advanced Features](articles/advanced-features.md)
-- [API Reference](api/index.md)
+!!! tip "See the [Getting Started](getting-started.md) guide for full setup instructions."