Added base for automated documentation
This commit is contained in:
1
docs/articles/getting-started.md
Normal file
1
docs/articles/getting-started.md
Normal file
@@ -0,0 +1 @@
|
||||
# Getting Started
|
||||
1
docs/articles/introduction.md
Normal file
1
docs/articles/introduction.md
Normal file
@@ -0,0 +1 @@
|
||||
# Introduction
|
||||
8
docs/articles/toc.yml
Normal file
8
docs/articles/toc.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
- name: Introduction
|
||||
href: introduction.md
|
||||
- name: Getting Started
|
||||
href: getting-started.md
|
||||
- name: GitHub
|
||||
href: https://github.com/AM-WD/cloudflare-api
|
||||
- name: NuGet
|
||||
href: https://www.nuget.org/packages?q=AMWD.Net.API.Cloudflare
|
||||
63
docs/docfx.json
Normal file
63
docs/docfx.json
Normal file
@@ -0,0 +1,63 @@
|
||||
{
|
||||
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"src": "../",
|
||||
"files": [
|
||||
"src/Cloudflare/bin/Release/netstandard2.0/amwd-cloudflare-core.dll",
|
||||
"src/Extensions/Cloudflare.Dns/bin/Release/netstandard2.0/amwd-cloudflare-dns.dll",
|
||||
"src/Extensions/Cloudflare.Zones/bin/Release/netstandard2.0/amwd-cloudflare-zones.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": "API for .NET",
|
||||
"_appTitle": "Cloudflare API for .NET",
|
||||
"_appFooter": "<span>© AM.WD — Docs generated using <a href=\"https://dotnet.github.io/docfx\" target=\"_blank\">docfx</a>.</span>",
|
||||
"_appLogoPath": "images/logo.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/cloudflare",
|
||||
"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: 6.3 KiB |
BIN
docs/images/logo.png
Normal file
BIN
docs/images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
22
docs/index.md
Normal file
22
docs/index.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
_layout: landing
|
||||
---
|
||||
|
||||
# Cloudflare API for .NET
|
||||
|
||||
|
||||
## NuGet packages
|
||||
|
||||
Here is an overview of the latest packages.
|
||||
|
||||
| Package URL | Version | Short Description |
|
||||
|-------------|---------|-------------------|
|
||||
| [AMWD.Net.API.Cloudflare] |  | Core features to access the Cloudflare API. |
|
||||
| [AMWD.Net.API.Cloudflare.Dns] |  | The DNS section of the Cloudflare API. |
|
||||
| [AMWD.Net.API.Cloudflare.Zones] |  | The Domain/Zone Management section of the Cloudflare API. |
|
||||
|
||||
|
||||
|
||||
[AMWD.Net.API.Cloudflare]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare
|
||||
[AMWD.Net.API.Cloudflare.Dns]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare.Dns
|
||||
[AMWD.Net.API.Cloudflare.Zones]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare.Zones
|
||||
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: Articles
|
||||
href: articles/
|
||||
Reference in New Issue
Block a user