Westwind.AspNetCore.Markdown 项目教程

2024-08-16 23:25:26作者：龚格成

Westwind.AspNetCore.Markdown

An ASP.NET Core Markdown support library that provides Markdown parsing, a Markdown TagHelper and Markdown Page Handler Middleware

1. 项目的目录结构及介绍

Westwind.AspNetCore.Markdown/
├── src/
│   ├── Westwind.AspNetCore.Markdown/
│   │   ├── Controllers/
│   │   ├── MarkdownPageProcessorMiddleware.cs
│   │   ├── MarkdownTagHelper.cs
│   │   ├── Markdown.cs
│   │   ├── MarkdownPageProcessorOptions.cs
│   │   ├── MarkdownTagHelperOptions.cs
│   │   ├── Startup.cs
│   │   ├── Westwind.AspNetCore.Markdown.csproj
│   │   └── README.md
│   └── Westwind.AspNetCore.Markdown.Tests/
│       ├── MarkdownTests.cs
│       ├── MarkdownTagHelperTests.cs
│       ├── Westwind.AspNetCore.Markdown.Tests.csproj
│       └── README.md
├── .gitignore
├── LICENSE
├── README.md
└── Westwind.AspNetCore.Markdown.sln

目录结构介绍

src/Westwind.AspNetCore.Markdown/: 项目的主要源代码目录。
- Controllers/: 包含控制器文件。
- MarkdownPageProcessorMiddleware.cs: 处理Markdown文件的中间件。
- MarkdownTagHelper.cs: Markdown标签助手。
- Markdown.cs: Markdown解析和处理的核心类。
- MarkdownPageProcessorOptions.cs: Markdown页面处理选项。
- MarkdownTagHelperOptions.cs: Markdown标签助手选项。
- Startup.cs: 项目的启动文件。
- Westwind.AspNetCore.Markdown.csproj: 项目文件。
- README.md: 项目说明文档。
src/Westwind.AspNetCore.Markdown.Tests/: 项目的测试代码目录。
- MarkdownTests.cs: Markdown解析和处理的测试。
- MarkdownTagHelperTests.cs: Markdown标签助手的测试。
- Westwind.AspNetCore.Markdown.Tests.csproj: 测试项目文件。
- README.md: 测试项目说明文档。
.gitignore: Git忽略文件配置。
LICENSE: 项目许可证。
README.md: 项目根目录的说明文档。
Westwind.AspNetCore.Markdown.sln: 解决方案文件。

2. 项目的启动文件介绍

Startup.cs

Startup.cs 文件是ASP.NET Core项目的启动文件，负责配置服务和应用的请求管道。以下是该文件的主要内容：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMarkdown();
        services.AddControllersWithViews();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
            app.UseHsts();
        }

        app.UseHttpsRedirection();
        app.UseStaticFiles();
        app.UseRouting();
        app.UseAuthorization();

        app.UseMarkdown();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}

主要功能

ConfigureServices 方法：注册Markdown服务和其他必要的服务。
Configure 方法：配置应用的请求管道，包括使用Markdown中间件。

3. 项目的配置文件介绍

appsettings.json

appsettings.json 文件是ASP.NET Core项目的配置文件，通常包含应用的配置设置。以下是一个示例配置文件：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "Markdown": {
    "BasePath": "~/Markdown",