### Directory structure example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/links-and-cross-references.md Shows the directory structure used in the local file link examples. ```text |- docfx.json |- file1.md |- subfolder |- file2.md ``` -------------------------------- ### Install docfx as a global tool Source: https://github.com/dotnet/docfx/blob/main/README.md Use this command to install docfx as a global .NET tool. Requires .NET SDK. ```bash dotnet tool install -g docfx ``` -------------------------------- ### Include example with filepath Source: https://github.com/dotnet/docfx/blob/main/docs/docs/markdown.md Example of including a markdown file from the includes folder. The filepath is relative to the current file. ```markdown [!INCLUDE [my-markdown-block](../../includes/my-markdown-block.md)] ``` -------------------------------- ### Install docfx global tool from local source Source: https://github.com/dotnet/docfx/blob/main/docs/index.md Installs docfx as a .NET Global Tool from the local source where the nupkg was downloaded. Uses the --prerelease flag to allow nightly versions. ```pwsh dotnet tool update docfx -g --prerelease --source ./ ``` -------------------------------- ### globalMetadata configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Contains metadata applied to every file. Example shows _appTitle and _enableSearch. When applying template 'default', _appTitle becomes part of the page title. ```json { "build": { "globalMetadata": { "_appTitle": "DocFX website", "_enableSearch": "true" } } } ``` -------------------------------- ### fileMetadata configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Specifies metadata associated with particular files using glob patterns. Shows priority, keywords, and _noindex examples. ```json { "build": { "fileMetadata": { "priority": { "**.md": 2.5, "spec/**.md": 3 }, "keywords": { "obj/docfx/**": ["API", "Reference"], "spec/**.md": ["Spec", "Conceptual"] }, "_noindex": { "articles/**/article.md": true } } } } ``` -------------------------------- ### Issue2723 code example Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md Code example for Issue2723, demonstrating a for loop and a Range initialization. ```csharp for (var i = 0; i > 10; i++) // & " ' var range = new Range { Min = 0, Max = 10 }; ``` -------------------------------- ### resource configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Specifies an array of resource files to include in the project. Supports File Mappings. ```json { "build": { "resource": ["**/*.png"] } } ``` -------------------------------- ### build configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Configuration options applied for the 'docfx build' command. Shows content, resource, and globalMetadata settings. ```json { "build": { "content": ["**/*.{md|yml}"], "resource": ["**/media/**"], "globalMetadata": { "_appTitle": "My App" } } } ``` -------------------------------- ### Partial template example Source: https://github.com/dotnet/docfx/blob/main/docs/spec/docfx_document_schema.md A Mustache template example that renders the title and description properties defined in xrefProperties. ```mustache {{title}}: {{{description}}} ``` -------------------------------- ### content configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Specifies an array of content files to include in the project. Supports File Mappings. ```json { "build": { "content": ["**/*.{md,yml}"] } } ``` -------------------------------- ### template configuration example (string) Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Specifies a single template to apply to each file. If omitted, the embedded 'default' template is used. ```json { "build": { "template": "custom", } } ``` -------------------------------- ### Highlight selected lines example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/markdown.md Example of highlighting lines 2, 5 to 7, and 9 to the end of the file in a code snippet. ```markdown [!code-csharp[](media/Program.cs?highlight=2,5-7,9-)] ``` -------------------------------- ### Method example in YAML Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md Shows the YAML representation of the ToString methods, including uid, id, name.csharp, and fullName.csharp. ```yaml - uid: System.String.ToString id: ToString name.csharp: ToString() fullName.csharp: System.String.ToString() - uid: System.String.ToString(System.IFormatProvider) id: ToString(System.IFormatProvider) name.csharp: ToString(IFormatProvider) fullName.csharp: System.String.ToString(System.IFormatProvider) ``` -------------------------------- ### fileMetadataFiles configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Sets fileMetadata from external files. ```json { "build": { "fileMetadataFiles": ["file1.json", "file2.json"], } } ``` -------------------------------- ### Method example in C# Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md Shows the C# definition of the String class with ToString methods. ```csharp namespace System { public sealed class String { public String ToString(); public String ToString(IFormatProvider provider); } } ``` -------------------------------- ### Constructor example in C# Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md Shows the C# definition of the String class with parameterless and parameterized constructors. ```csharp namespace System { public sealed class String { public String(); public String(char[] chars); } } ``` -------------------------------- ### Constructor example in YAML Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md Shows the YAML representation of the String constructors, including uid, id, name.csharp, and fullName.csharp. ```yaml - uid: System.String.#ctor id: #ctor name.csharp: String() fullName.csharp: System.String.String() - uid: System.String.#ctor(System.Char[]) id: #ctor(System.Char[]) name.csharp: String(Char[]) fullName.csharp: System.String.String(System.Char[]) ``` -------------------------------- ### template configuration example (array) Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Specifies an array of templates. Later templates override earlier ones if file names collide. ```json { "build": { "template": ["default", "my-custom-template"], } } ``` -------------------------------- ### globalMetadataFiles configuration example Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-json-reference.md Sets globalMetadata from external files. ```json { "build": { "globalMetadataFiles": ["global1.json", "global2.json"] } } ``` -------------------------------- ### YAML Indexer Example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md YAML metadata for the C# indexer shown above, with uid, id, name.csharp, and fullName.csharp for the indexer. ```yaml - uid: "System.Collections.IList.Item[System.Int32]" id: "Item[System.Int32]" name.csharp: Item[Int32] fullName.csharp: System.Collections.IList.Item[System.Int32] ``` -------------------------------- ### Naming: camelCasing for Parameters Source: https://github.com/dotnet/docfx/blob/main/samples/seed/articles/csharp_coding_standards.md Mandatory: use camelCasing for parameter names. Examples: propertyDescriptor, htmlTag, ioStream. ```text propertyDescriptor htmlTag ioStream ``` -------------------------------- ### Operator overload example in YAML Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md Shows the YAML representation of the operator overloads, including uid, id, name.csharp, and fullName.csharp. ```yaml - uid: System.Decimal.op_Implicit(System.Char)~System.Decimal id: op_Implicit(System.Char)~System.Decimal name.csharp: Implicit(Char to Decimal) fullName.csharp: System.Decimal.Implicit(System.Char to System.Decimal) - uid: System.String.op_Equality(System.String,System.String) id: op_Equality(System.String,System.String) name.csharp: Equality(String,String) fullName.csharp: System.String.Equality(System.String,System.String) ``` -------------------------------- ### Run docfx and serve with browser Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx.md Runs the metadata, build, and pdf commands, then serves the generated site and opens it in the default browser. ```pwsh docfx --serve --open-browser ``` -------------------------------- ### Naming: Private Fields Start with Underscore Source: https://github.com/dotnet/docfx/blob/main/samples/seed/articles/csharp_coding_standards.md Mandatory: private fields start with underscore. Example shows a private readonly Guid field. ```csharp private readonly Guid _userId = Guid.NewGuid(); ``` -------------------------------- ### GET manager link for a contact Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Build.RestApi.Tests/TestData/contacts-operations.md Example request that returns a link to the specified contact's manager using the $links resource path. ```no-highlight GET https://graph.windows.net/myorganization/contacts/a2fb3752-08b4-413d-af6f-1d99c4c131d9/$links/manager?api-version=1.6 ``` -------------------------------- ### Shorthand @ reference syntax (Markdown) Source: https://github.com/dotnet/docfx/blob/main/docs/spec/metadata_format_spec.md A string starting with @ and followed by a quoted string is treated as an item reference, where the quoted content is the UID. The example references 'System.String'. ```markdown @"System.String" ``` -------------------------------- ### docfx build --serve --open-browser Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-build.md Builds static site contents with the default docfx.json config, then serves the generated site and opens it in the default browser. ```pwsh docfx build --serve --open-browser ``` -------------------------------- ### Rendered HTML for relative local file link Source: https://github.com/dotnet/docfx/blob/main/docs/docs/links-and-cross-references.md The HTML output produced by the relative local file link example. ```html file2 ``` -------------------------------- ### Naming: Static Readonly Fields and Constants Capitalized Source: https://github.com/dotnet/docfx/blob/main/samples/seed/articles/csharp_coding_standards.md Mandatory: static readonly fields and constants start with capitalized case. Examples show a static readonly field and a const string. ```csharp private static readonly IEntityAccessor EntityAccessor = null; private const string MetadataName = "MetadataName"; ``` -------------------------------- ### Build the project with dotnet run Source: https://github.com/dotnet/docfx/blob/main/samples/extensions/README.md Run this command in the sample directory to build the project using the Docfx.App package. This replaces the global docfx command-line tool. ```bash dotnet run --project build ``` -------------------------------- ### Image Embedding Example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/markdown.md Example of embedding an image from learn.microsoft.com. ```markdown ![alt-text](https://learn.microsoft.com/en-us/media/learn/not-found/learn-not-found-light-mode.png?branch=main) ``` -------------------------------- ### Video Embedding Example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/markdown.md Example of embedding a YouTube video using the [!Video] syntax. ```markdown > [!Video https://www.youtube.com/embed/Sz1lCeedcPI] ``` -------------------------------- ### docfx init usage Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-init.md Shows the basic usage syntax for the docfx init command. ```pwsh docfx init [OPTIONS] ``` -------------------------------- ### Issue4017 example code Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md Example code for Issue4017, showing how to hook MessageDeleted and handle the deletion event. ```csharp public void HookMessageDeleted(BaseSocketClient client) { client.MessageDeleted += HandleMessageDelete; } public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) { // check if the message exists in cache; if not, we cannot report what was removed if (!cachedMessage.HasValue) return; var message = cachedMessage.Value; Console.WriteLine($"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):" + Environment.NewLine + message.Content); return Task.CompletedTask; } ``` -------------------------------- ### Initialize and serve a docfx site Source: https://github.com/dotnet/docfx/blob/main/README.md Initializes a new docfx project and builds it with a local server. The site is available at https://localhost:8080. ```bash docfx init -y docfx build docfx_project\docfx.json --serve ``` -------------------------------- ### Issue2623 example code Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.verified.md Example code for Issue2623, showing instantiation of MyClass and an Update method that calls Execute. ```csharp MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } ``` -------------------------------- ### Run the Docfx build command Source: https://github.com/dotnet/docfx/blob/main/docs/docs/basic-concepts.md Use this command to execute the build step for a Docfx project. Append --serve to start a local web server for previewing the output. ```shell docfx build path/to/docfx.json ``` -------------------------------- ### SqlFunctions.CharIndex(String, String, Nullable) Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Returns the starting position of one expression within another. This overload accepts a nullable long for the start location. ```APIDOC ## SqlFunctions.CharIndex(String, String, Nullable) ### Description Returns the starting position of one expression within another. This overload accepts a nullable long for the start location. ### Method CharIndex ### Parameters - **stringToFind** (String) - Required - The string to find. - **target** (String) - Required - The string to search. - **startLocation** (Nullable) - Required - The start location for the search. ### Return Value Nullable - The starting position of the found string. ``` -------------------------------- ### docfx init [OPTIONS] Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-init.md Generates an initial docfx.json file following interactive instructions. Use options to skip prompts and specify output directory. ```APIDOC ## docfx init [OPTIONS] ### Description Generates an initial docfx.json file following interactive instructions. Use options to skip prompts and specify output directory. ### Method CLI ### Endpoint N/A ### Parameters #### Options - **-h|--help** (boolean) - Optional - Prints help information - **-y|--yes** (boolean) - Optional - Yes to all questions - **-o|--output** (string) - Optional - Specify the output directory of the generated files ### Request Example ```pwsh docfx init --yes ``` ### Response #### Success Response - Exit code 0 on success #### Response Example ``` (no output) ``` ``` -------------------------------- ### C# Example for Spec Identifier Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-yaml-format.md C# code example used to illustrate spec identifiers. It defines a class with a method that uses generic type parameters, arrays, and pointers. ```csharp namespace Foo { public class Bar { public unsafe List FooBar(int[] arg, byte* arg2, TArg arg3, List arg4) { return null; } } } ``` -------------------------------- ### HelloWorld static method Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Class1.verified.md Static method that prints 'Hello World'. ```csharp public static void HelloWorld() ``` -------------------------------- ### File Layout: Class and Filename Source: https://github.com/dotnet/docfx/blob/main/samples/seed/articles/csharp_coding_standards.md Recommended rule: only one public class per file, with the filename derived from the class name. Example shows class 'Observer' in file 'Observer.cs'. ```text Class : Observer Filename: Observer.cs ``` -------------------------------- ### ExportMetadataAttribute.Value Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the metadata value. ```APIDOC ## ExportMetadataAttribute.Value ### Description Gets the metadata value. ### Property Value ### Signature public object Value { get; } ``` -------------------------------- ### Generate initial docfx files with defaults Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-init.md Generates initial docfx files in the current directory with default configurations, answering yes to all questions. ```pwsh docfx init --yes ``` -------------------------------- ### ExportMetadataAttribute.Name Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the metadata name. ```APIDOC ## ExportMetadataAttribute.Name ### Description Gets the metadata name. ### Property Name ### Signature public string Name { get; } ``` -------------------------------- ### Name Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Dog.verified.md Gets the name of the dog. ```APIDOC ## Name ### Description Gets the name of the dog. ### Property Value - **Name** (string) - The name of the dog. ### Code ```csharp public string Name { get; } ``` ``` -------------------------------- ### Age Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Dog.verified.md Gets the age of the dog. ```APIDOC ## Age ### Description Gets the age of the dog. ### Property Value - **Age** (int) - The age of the dog. ### Code ```csharp public int Age { get; } ``` ``` -------------------------------- ### Filter by UID with uidRegex Source: https://github.com/dotnet/docfx/blob/main/docs/docs/dotnet-api-docs.md YAML filter rules that include APIs whose UID starts with 'Microsoft.DevDiv.SpecialCase' and exclude all other APIs whose UID starts with 'Microsoft.DevDiv'. Rules are processed sequentially and stop when a rule matches. ```yaml apiRules: - include: uidRegex: ^Microsoft\.DevDiv\.SpecialCase - exclude: uidRegex: ^Microsoft\.DevDiv ``` -------------------------------- ### ExportAttribute.ContractType Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the contract type for the export. ```APIDOC ## ExportAttribute.ContractType ### Description Gets the contract type for the export. ### Property ContractType ### Signature public Type ContractType { get; } ``` -------------------------------- ### ExportAttribute.ContractName Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the contract name for the export. ```APIDOC ## ExportAttribute.ContractName ### Description Gets the contract name for the export. ### Property ContractName ### Signature public string ContractName { get; } ``` -------------------------------- ### Run docfx with default config Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx.md Runs the metadata, build, and pdf commands using the default 'docfx.json' configuration file. ```pwsh docfx ``` -------------------------------- ### Export.Value Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the exported value. ```APIDOC ## Export.Value ### Description Gets the exported value. ### Property Value ### Signature public T Value { get; } ``` -------------------------------- ### YAML example: Reference section with template instantiation Source: https://github.com/dotnet/docfx/blob/main/docs/spec/metadata_format_spec.md Shows how to define a reference item for a template instance (List) and its referenced items (List and int) with UID, link, name, and URL properties. ```yaml items: - uid: NumberList inherits: - System.Collections.Generic.List references: - uid: System.Collections.Generic.List`1 link: @"System.Collections.Generic.List`1"<@"System.Int32"> - uid: System.Collections.Generic.List`1 name: List url: system.collections.generic.list`1.yml - uid: System.Int32 name: int url: system.int32.yml ``` -------------------------------- ### Foo Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md Gets the Foo property of type int. ```APIDOC ## Foo ### Description Gets the Foo property of type int. ### Property Value - **Foo** (int) - The value of the Foo property. ``` -------------------------------- ### Initialize DocFX configuration Source: https://github.com/dotnet/docfx/blob/main/docs/docs/publish-azure-devops.md Run this command to generate a docfx.json configuration file in your repository. It is the first step in setting up DocFX locally before creating the Azure DevOps pipeline. ```bash docfx init -q ``` -------------------------------- ### Baz Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md Gets the Baz property of type string. ```APIDOC ## Baz ### Description Gets the Baz property of type string. ### Property Value - **Baz** (string) - The value of the Baz property. ``` -------------------------------- ### Bar Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromProject.Class1.Issue8665.verified.md Gets the Bar property of type char. ```APIDOC ## Bar ### Description Gets the Bar property of type char. ### Property Value - **Bar** (char) - The value of the Bar property. ``` -------------------------------- ### docfx download command syntax Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-download.md Shows the basic syntax for the docfx download command. The argument is required and specifies the path for the downloaded file. ```pwsh docfx download [OPTIONS] ``` -------------------------------- ### Issue5432.Name Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromAssembly.Issue5432.verified.md Gets the Name property of the Issue5432 struct. ```APIDOC ## Property: Name ### Description Gets the Name property of the Issue5432 struct. ### Property Signature ```csharp public string Name { get; } ``` ### Property Value - **Type**: [string](https://learn.microsoft.com/dotnet/api/system.string) - **Access**: Read-only (getter only) ``` -------------------------------- ### Navigation bar TOC example Source: https://github.com/dotnet/docfx/blob/main/docs/docs/table-of-contents.md Creates a navigation bar with two entries, 'Docs' and 'API', each linking to a directory. The `toc.yml` file in the `docfx.json` folder is used for the navigation bar. ```yaml - name: Docs href: docs/ - name: API href: api/ ``` -------------------------------- ### docfx build - default config Source: https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-cli-reference/docfx-build.md Builds static site contents using the default docfx.json configuration file. ```pwsh docfx build ``` -------------------------------- ### Main(string[]) Source: https://github.com/dotnet/docfx/blob/main/test/docfx.Snapshot.Tests/SamplesTest.SeedMarkdown/BuildFromCSharpSourceCode.CSharp.verified.md The Main method is the entry point of the CSharp class. It accepts an array of string arguments and returns void. ```APIDOC ## Main(string[]) ### Description The Main method is the entry point of the CSharp class. It accepts an array of string arguments and returns void. ### Method Main ### Signature public static void Main(string[] args) ### Parameters - **args** (string[]) - Required - An array of string arguments passed to the method. ### Return Type void ``` -------------------------------- ### docfx.json sample for multi-targeting with TargetFramework Source: https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md Sample docfx.json configuration for multi-targeting with the latest csproj format. It specifies TargetFramework properties for metadata generation, merges YAML files from different frameworks, and builds the site. ```json { "metadata": [ { "src": "*.csproj", "dest": "temp/api/netstandard1.4", "properties": { "TargetFramework": "netstandard1.4" } }, { "src": "*.csproj", "dest": "temp/api/net46", "properties": { "TargetFramework": "net46" } } ], "merge": { "content": [ { "files": "*.yml", "src": "temp/api/netstandard1.4" }, { "files": "*.yml", "src": "temp/api/net46" } ], "fileMetadata": { "platform": { "temp/api/netstandard1.4/*.yml": [ "netstandard1.4" ], "temp/api/net46/*.yml": [ "net46" ] } }, "dest": "api" }, "build": { "content": [ { "files": [ "api/*.yml", "**.md", "**/toc.yml" ] } ], "dest": "_site" } } ``` -------------------------------- ### ExportFactory.Metadata Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the metadata associated with the export. ```APIDOC ## ExportFactory.Metadata ### Description Gets the metadata associated with the export. ### Property Metadata ### Signature public TMetadata Metadata { get; } ``` -------------------------------- ### Customize URL with src and dest in docfx.json Source: https://github.com/dotnet/docfx/blob/main/docs/docs/config.md Customizes URL patterns by removing the 'articles' directory from the URL and inserting 'docs' as a prefix. Files like articles/getting-started/installation.md become accessible at docs/getting-started/installation.html. ```json { "build": { "content": [ { "files": "**/*.{md,yml}", "src": "articles", "dest": "docs" } ] } } ``` -------------------------------- ### RegexStringValidatorAttribute.ValidatorInstance Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the validator instance. This property is part of the System.Configuration.RegexStringValidatorAttribute class. ```APIDOC ## RegexStringValidatorAttribute.ValidatorInstance ### Description Gets the validator instance. ### Property ValidatorInstance ### Parameters None ### Return Value ConfigurationValidatorBase ``` -------------------------------- ### RsaProtectedConfigurationProvider.RsaPublicKey Source: https://github.com/dotnet/docfx/blob/main/test/Docfx.Dotnet.Tests/TestData/dotnet-xrefmap.txt Gets the RSA public key. This property is part of the System.Configuration.RsaProtectedConfigurationProvider class. ```APIDOC ## RsaProtectedConfigurationProvider.RsaPublicKey ### Description Gets the RSA public key. ### Property RsaPublicKey ### Parameters None ### Return Value String ```