diff --git a/DisCatSharp.Docs/api/index.md b/DisCatSharp.Docs/api/index.md index 63bdc1a0c..39e6a172f 100644 --- a/DisCatSharp.Docs/api/index.md +++ b/DisCatSharp.Docs/api/index.md @@ -1,11 +1,11 @@ # API Reference --- uid: api_index title: DisCatSharp Global API --- Welcome to the DisCatSharp Global API reference. -To begin, a package on the left. - -If you encounter any problems or see typos, please inform us on our [Discord server](https://discord.gg/Uk7sggRBTm). +List of all packages: +- [DisCatSharp](xref:api_discatsharp_index.md) +- [DisCatSharp.Interactivity](xref:api_discatsharp_interactivity_index.md) diff --git a/DisCatSharp.Docs/docfx.json b/DisCatSharp.Docs/docfx.json index 771706b09..211d57a61 100644 --- a/DisCatSharp.Docs/docfx.json +++ b/DisCatSharp.Docs/docfx.json @@ -1,119 +1,120 @@ { "metadata": [ { "src": [ { "src": "../DisCatSharp/", "files": [ "**.csproj" ], "exclude": [ "**/obj/**", "**/bin/**", "_site/**" ] } ], "dest": "api/DisCatSharp", "filter": "filter_config.yml" }, { "src": [ { "src": "../DisCatSharp.Interactivity/", "files": [ "**.csproj" ], "exclude": [ "**/obj/**", "**/bin/**", "_site/**" ] } ], "dest": "api/DisCatSharp.Interactivity", "filter": "filter_config.yml" } ], "build": { + "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ], "content": [ { "files": [ "api/**/**.yml", "api/**/**.md" ] }, { "files": [ "**.md", "toc.yml", "faq/**.yml", "faq/**.md", "articles/**.yml", "articles/**.md", "natives/**.yml", "natives/**.md" ], "exclude": [ "**/bin/**", "**/obj/**", "_site/**", "dcs/**" ] } ], "resource": [ { "files": [ "images/**", "natives/**.zip" ], "exclude": [ "**/bin/**", "**/obj/**", "_site/**", "images/_**" ] } ], "overwrite": [ { "files": [], "exclude": [ "**/bin/**", "**/obj/**", "_site/**" ] } ], "dest": "_site", "globalMetadata": { "_appFooter": "© 2021-2022 Aiko IT Systems", "_enableSearch": true, "_enableNewTab": true, "_appTitle": "DisCatSharp Docs", "_gitUrlPattern": "git", "_gitContribute": { "repo": "https://github.com/Aiko-IT-Systems/DisCatSharp", "branch": "main" } }, "disableGitFeatures": false, "exportRawModel": true, "rawModelOutputFolder": "_site/.bot-query/raw/", "globalMetadataFiles": [], "fileMetadataFiles": [], "template": [ "dcs" ], "postProcessors": ["ExtractSearchIndex", "CustomMemberIndexer"], "noLangKeyword": false, "keepFileLink": false, "cleanupCacheHistory": false, "sitemap": { "baseUrl": "https://docs.discatsharp.tech/", "changefreq": "daily", "priority": 1.0 } } } diff --git a/DisCatSharp.Docs/filter_config.yml b/DisCatSharp.Docs/filter_config.yml index 867d97547..0fe7ea8cf 100644 --- a/DisCatSharp.Docs/filter_config.yml +++ b/DisCatSharp.Docs/filter_config.yml @@ -1,132 +1,11 @@ apiRules: -- exclude: - uidRegex: ^System\.Collections\.Immutable$ -- exclude: - uidRegex: ^System\.Runtime\.CompilerServices\.Unsafe$ -- exclude: - uidRegex: ^System\.Runtime\.CompilerServices$ -- exclude: - uidRegex: ^System - exclude: uidRegex: ^DisCatSharp\.Hosting\.Tests$ - exclude: - uidRegex: ^DisCatSharp\.Tests + uidRegex: ^DisCatSharp\.Tests$ - exclude: uidRegex: ^DisCatSharp\.Configuration\.Tests$ - include: uidRegex: ^DisCatSharp -attributeRules: -- exclude: - uidRegex: ^System\.Collections\.Immutable$ - type: Namespace -- exclude: - uidRegex: ^Microsoft\.Extensions\.Logging$ - type: Namespace -- exclude: - uidRegex: ^Microsoft\.Extensions\.Logging\.LogLevel$ - type: Namespace -- exclude: - uidRegex: ^Microsoft\.Extensions\.Hosting\.BackgroundService$ - type: Namespace -- exclude: - uidRegex: ^Microsoft\.Extensions\.Hosting$ - type: Namespace -- exclude: - uidRegex: ^Microsoft\.Extensions$ - type: Namespace - exclude: uidRegex: ^Newtonsoft\.Json$ - type: Namespace -- exclude: - uidRegex: ^Newtonsoft\.Json\.JsonConverter$ - type: Namespace -- exclude: - uidRegex: ^System\.Runtime\.CompilerServices\.Unsafe$ - type: Namespace -- exclude: - uidRegex: ^System\.Runtime\.CompilerServices$ - type: Namespace -- exclude: - uidRegex: ^System\.ComponentModel\.Design$ - type: Namespace -- exclude: - uidRegex: ^System\.ComponentModel\.Design\.Serialization$ - type: Namespace -- exclude: - uidRegex: ^System\.Xml\.Serialization$ - type: Namespace -- exclude: - uidRegex: ^System\.Web\.Compilation$ - type: Namespace -- exclude: - uidRegex: ^System\.Runtime\.Versioning$ - type: Namespace -- exclude: - uidRegex: ^System\.Runtime\.ConstrainedExecution$ - type: Namespace -- exclude: - uidRegex: ^System\.EnterpriseServices$ - type: Namespace -- exclude: - uidRegex: ^System\.Numerics$ - type: Namespace -- exclude: - uidRegex: ^System\.Numerics\.Complex$ - type: Namespace -- exclude: - uidRegex: '^System\.[^.]+$' - type: Namespace -- exclude: - uidRegex: ^System\.Diagnostics\.CodeAnalysis$ - type: Namespace -- include: - uidRegex: ^System\.Diagnostics\.(ConditionalAttribute|EventLogPermissionAttribute|PerformanceCounterPermissionAttribute)$ - type: Type -- exclude: - uidRegex: '^System\.Diagnostics\.[^.]+$' - type: Type -- include: - uidRegex: ^System\.ComponentModel\.(BindableAttribute|BrowsableAttribute|ComplexBindingPropertiesAttribute|DataObjectAttribute|DefaultBindingPropertyAttribute|ListBindableAttribute|LookupBindingPropertiesAttribute|SettingsBindableAttribute|TypeConverterAttribute)$ - type: Type -- exclude: - uidRegex: '^System\.ComponentModel\.[^.]+$' - type: Type -- exclude: - uidRegex: ^System\.Reflection\.DefaultMemberAttribute$ - type: Type -- exclude: - uidRegex: ^System\.CodeDom\.Compiler\.GeneratedCodeAttribute$ - type: Type -- exclude: - uidRegex: ^Microsoft\.Extensions\.Hosting\.BackgroundService$ - type: Type -- exclude: - uidRegex: ^Microsoft\.Extensions\.Logging\.LogLevel\.Information$ - type: Type -- exclude: - uidRegex: ^Microsoft\.Extensions\.Logging\.ILoggerFactory$ - type: Type -- exclude: - uidRegex: ^Newtonsoft\.Json\.JsonConverter$ - type: Type -- exclude: - uidRegex: ^System\.Numerics\.Complex$ - type: Type -- exclude: - uidRegex: '^System\.Runtime\.CompilerServices\.[^.]+$' - type: Type -- exclude: - uidRegex: '^System\.Runtime\.InteropServices\.[^.]+$' - type: Type -- include: - uidRegex: ^System\.Security\.(SecurityCriticalAttribute|SecurityTreatAsSafeAttribute|AllowPartiallyTrustedCallersAttribute)$ - type: Type -- exclude: - uidRegex: '^System\.Security\.[^.]+$' - type: Type -- exclude: - uidRegex: '^System\.Web\.UI\.[^.]+$' - type: Type -- exclude: - uidRegex: '^System\.Windows\.Markup\.[^.]+$' - type: Type