tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-12-26 19:05:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs redesign (#728)

Browse Source 
* Adding a dark mode
* Adding reference for types to summary pages
* Adding API Reference
* Adding modifiers to methods/fields/etc
* Minimizing files input
* Caching a lot of the output pages
* Cache only for each execution
* Adding API references to existing docs
This commit is contained in:
Phil Scott
2022-02-14 12:44:25 -05:00
committed by GitHub
parent 74a2e10ff0
commit c2da268129
147 changed files with 4112 additions and 6897 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/src/Constants.cs
View File

@@ -2,14 +2,26 @@ namespace Docs
{
public static class Constants
{
public const string NoContainer = nameof(NoContainer);
public const string NoSidebar = nameof(NoSidebar);
public const string NoLink = nameof(NoLink);
public const string Topic = nameof(Topic);
public const string EditLink = nameof(EditLink);
public const string Description = nameof(Description);
public const string Hidden = nameof(Hidden);
/// <summary>
/// Indicates where to locate source files for the API documentation.
/// By default the globbing pattern "src/**/{!bin,!obj,!packages,!*.Tests,}/**/*.cs"
/// is used which searches for all "*.cs" files at any depth under a "src" folder
/// but not under "bin", "obj", "packages" or "Tests" folders. You can specify
/// your own globbing pattern (or more than one globbing pattern) if your source
/// files are found elsewhere.
/// </summary>
/// <type><see cref="string"/> or <c>IEnumerable&lt;string&gt;</c></type>
public const string SourceFiles = nameof(SourceFiles);
public const string ExampleSourceFiles = nameof(ExampleSourceFiles);
public const string ApiReference = "Reference";
public static class Emojis
{
public const string Root = "EMOJIS_ROOT";
@@ -27,18 +39,11 @@ namespace Docs
public const string Repository = "SITE_REPOSITORY";
public const string Branch = "SITE_BRANCH";
}
public static class Deployment
{
public const string GitHubToken = "GITHUB_TOKEN";
public const string TargetBranch = "DEPLOYMENT_TARGET_BRANCH";
}
public static class Sections
{
public const string Splash = nameof(Splash);
public const string Sidebar = nameof(Sidebar);
public const string Subtitle = nameof(Subtitle);
}
}
}