diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..9c527f8 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,61 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", + "metadata": [ + { + "src": [ + { + "src": "../", + "files": [ + "src/FritzCallMonitor/bin/Release/netstandard2.0/amwd-fritz-callmonitor.dll" + ] + } + ], + "dest": "api", + "outputFormat": "apiPage" + } + ], + "build": { + "content": [ + { + "files": [ "**/*.{md,yml}" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "resource": [ + { + "files": [ "images/**" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "output": "_site", + "template": [ "default", "modern", "templates/amwd" ], + "postProcessors": ["ExtractSearchIndex"], + "globalMetadata": { + "_appName": "FRITZ!Box call monitor for .NET", + "_appTitle": "FRITZ!Box call monitor for .NET", + "_appFooter": "© AM.WD — Docs generated using docfx.", + "_appLogoPath": "images/icon.png", + "_appFaviconPath": "images/favicon.ico", + "_disableBreadcrumb": true, + "_disableContribution": true, + "_enableSearch": true, + "_enableNewTab": true, + "pdf": false + }, + "markdownEngineName": "markdig", + "markdownEngineProperties": { + "alerts": { + "TODO": "alert alert-secondary" + } + }, + "sitemap": { + "baseUrl": "https://docs.am-wd.de/fritzcallmonitor", + "priority": 0.5, + "changefreq": "weekly" + }, + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": true + } +} \ No newline at end of file diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000..578cdee Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/images/icon.png b/docs/images/icon.png new file mode 100644 index 0000000..ffd861b Binary files /dev/null and b/docs/images/icon.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..7b1682a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,31 @@ +--- +_layout: landing +--- + +# FRITZ!Box call monitor + +The FRITZ!Box is a widely used router for various internet service providers. + +These devices provide an endpoint to read all notifications of phone calls. +Incoming and outgoing including whether it is answered or hang-up. + + +## Enable / Disable + +To enable the call monitor endpoint on your FRITZ!Box, call `#96*5*`. +To disable the call monitor endpoint on your FRITZ!Box, call `#96*4*`. + +The endpoint will be available using the name or IP address of your FRITZ!Box and the port 1012 on TCP. + + +## NuGet packages + +Here is an overview of the latest package. + +| Package URL | Version | Short Description | +|-------------|---------|-------------------| +| [AMWD.Net.Api.Fritz.CallMonitor] | ![NuGet Version](https://img.shields.io/nuget/v/AMWD.Net.Api.Fritz.CallMonitor?style=flat-square&logo=nuget) | Package to connect to the call monitor endpoint. | + + + +[AMWD.Net.Api.Fritz.CallMonitor]: https://www.nuget.org/packages/AMWD.Net.Api.Fritz.CallMonitor diff --git a/docs/templates/amwd/public/main.css b/docs/templates/amwd/public/main.css new file mode 100644 index 0000000..057f8d0 --- /dev/null +++ b/docs/templates/amwd/public/main.css @@ -0,0 +1,3 @@ +#logo { + margin-right: 8px; +} \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..b63d6c9 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: API + href: api/ +- name: GitHub + href: https://github.com/AM-WD/FritzCallMonitor