Added docs
This commit is contained in:
61
docs/docfx.json
Normal file
61
docs/docfx.json
Normal file
@@ -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": "<span>© AM.WD — Docs generated using <a href=\"https://dotnet.github.io/docfx\" target=\"_blank\">docfx</a>.</span>",
|
||||
"_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
|
||||
}
|
||||
}
|
||||
BIN
docs/images/favicon.ico
Normal file
BIN
docs/images/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
BIN
docs/images/icon.png
Normal file
BIN
docs/images/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.6 KiB |
31
docs/index.md
Normal file
31
docs/index.md
Normal file
@@ -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] |  | Package to connect to the call monitor endpoint. |
|
||||
|
||||
|
||||
|
||||
[AMWD.Net.Api.Fritz.CallMonitor]: https://www.nuget.org/packages/AMWD.Net.Api.Fritz.CallMonitor
|
||||
3
docs/templates/amwd/public/main.css
vendored
Normal file
3
docs/templates/amwd/public/main.css
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
#logo {
|
||||
margin-right: 8px;
|
||||
}
|
||||
4
docs/toc.yml
Normal file
4
docs/toc.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
- name: API
|
||||
href: api/
|
||||
- name: GitHub
|
||||
href: https://github.com/AM-WD/FritzCallMonitor
|
||||
Reference in New Issue
Block a user