{"id":17914356,"url":"https://github.com/enisn/markdowndocumenting","last_synced_at":"2025-07-05T05:05:46.460Z","repository":{"id":95443305,"uuid":"159729970","full_name":"enisn/MarkdownDocumenting","owner":"enisn","description":"AspNetCore Markdown Documenting","archived":false,"fork":false,"pushed_at":"2021-10-13T09:44:50.000Z","size":97,"stargazers_count":21,"open_issues_count":3,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-28T12:16:42.437Z","etag":null,"topics":["aspnetcore","documentation","documentation-tool","markdown","netcore","netcore-webapi"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enisn.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-29T21:30:55.000Z","updated_at":"2024-04-08T20:42:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"28820e67-4c05-4260-bdb9-5eaefb88d0d2","html_url":"https://github.com/enisn/MarkdownDocumenting","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/enisn/MarkdownDocumenting","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enisn%2FMarkdownDocumenting","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enisn%2FMarkdownDocumenting/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enisn%2FMarkdownDocumenting/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enisn%2FMarkdownDocumenting/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enisn","download_url":"https://codeload.github.com/enisn/MarkdownDocumenting/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enisn%2FMarkdownDocumenting/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263687150,"owners_count":23496088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aspnetcore","documentation","documentation-tool","markdown","netcore","netcore-webapi"],"created_at":"2024-10-28T19:57:50.460Z","updated_at":"2025-07-05T05:05:46.445Z","avatar_url":"https://github.com/enisn.png","language":"C#","readme":"# AspNetCore.MarkdownDocumenting\n\n\nThis project provides markdown documentation for your .net core projects automaticly.\n\n\u003ca href=\"https://www.nuget.org/packages/AspNetCore.MarkdownDocumenting\"\u003e\n    \u003cimg src=\"https://img.shields.io/nuget/v/AspNetCore.MarkdownDocumenting?logo=nuget\u0026style=flat-square\" alt=\"NuGet\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://www.codefactor.io/repository/github/enisn/markdowndocumenting\"\u003e\n    \u003cimg src=\"https://www.codefactor.io/repository/github/enisn/markdowndocumenting/badge\" alt=\"CodeFactor\" /\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://gitmoji.carloscuesta.me\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square\" alt=\"Gitmoji\"\u003e\n\u003c/a\u003e\n\n\u003chr /\u003e\n\n# How does it work ?\n\nIt's easy. Just place your markdown documents under Docs folder and go **/Docs** path in your project.\n\n\u003ctable\u003e \n\u003ctr\u003e\n\u003ctd\u003e\u003cimg width=\"360\" src=\"https://github.com/enisn/MarkdownDocumenting/blob/master/images/screen_01.PNG?raw=true\" alt=\"AspNet Core Markdown Documentation\" /\u003e \u003c/td\u003e\n\u003ctd\u003e \u003cimg width=\"360\" src=\"https://github.com/enisn/MarkdownDocumenting/blob/master/images/screen_00.PNG?raw=true\" alt=\"AspNet Core Markdown Documentation\"\u003e \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\n* * *\n\n# How to start using ?\n\n- Install [NuGet package](https://www.nuget.org/packages/AspNetCore.MarkdownDocumenting/).\n\n- Create a folder into your project root which name is `Docs`. And put your **Markdown** files under it. You can use Sub Folders to group them.\n\n- You must set your **.md** files `Copy To Output Directory` as `Copy Always`. *To do this. Right click the markdown file and go Properties, then you'll see that option. Just change it.*\n\n    - Or you can add following code to your .csproj file in `\u003cProject\u003e` tags to apply it all files in `/Docs` folder:\n        ```xml\n            \u003cItemGroup\u003e\n                \u003cNone Update=\"Docs\\**\\*.md\"\u003e\n                    \u003cCopyToOutputDirectory\u003eAlways\u003c/CopyToOutputDirectory\u003e\n                \u003c/None\u003e\n             \u003c/ItemGroup\u003e\n        ```\n\n- Go to `Startup.cs` and add following code to your ConfigureServices method:\n    \n```csharp\n\npublic void ConfigureServices(IServiceCollection services)\n{\n    services.AddControllersWithViews(); // \u003c-- Must be added Views into IoC. Also '.AddMvc' can be used too.\n\n    services.AddDocumentation(); // Add this for default configuration.\n}\n\n```\n\n- Go to `Startup.cs` and add following code to your Configure method:\n\n```csharp\n    public void Configure(IApplicationBuilder app, IHostingEnvironment env)\n    {\n        //...\n        app.UseDocumentation(); // \u003c --- Add this for default configuration.\n        //...\n    }\n```\n\n\n* * *\n\n# Customization:\n\n- To Change Index Document\n\n```csharp\n    app.UseDocumentation(builder =\u003e\n    {\n        // this makes ~/Docs/Welcome.md file as your landing page at \"/\" and \"/Docs\"\n        builder.SetIndexDocument(\"Welcome.md\");   \n    });\n```\n\n## Custom links\n\n- Use `AddCustomLink()` and `AddFooterLink()` to add menu items into UseDocumentation() method in Startup.cs.\n\n Example:\n\n```csharp\n    app.UseDocumentation(builder =\u003e\n    {\n        builder\n            // this adds link to footer\n            .AddFooterLink(new Elements.CustomLink(\"See on NuGet\", \"https://www.nuget.org/packages/AspNetCore.MarkdownDocumenting/\"))\n            // this adds link to end of menu drawer.\n            .AddCustomLink(new Elements.CustomLink(\"Swagger UI\",\"/swagger\"));\n    });\n```\n\n\n## Theming\n\n- To Change Layout:\n\n```csharp\n    app.UseDocumentation(builder =\u003e\n    {\n        builder.Layout = \"/Shared/_Layout\";\n    });\n```\n\n- To Change Highlight.js theme:\n\n```csharp\n    app.UseDocumentation(builder =\u003e\n    {\n        builder.HighlightJsStyle = \"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/vs2015.min.css\";   \n    });\n```\n\n- To Change GetMdl theme:\n\n```csharp\n    app.UseDocumentation(builder =\u003e\n    {\n        builder.GetMdlStyle = \"https://code.getmdl.io/1.3.0/material.blue_grey-pink.min.css\";   \n    });\n```\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenisn%2Fmarkdowndocumenting","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenisn%2Fmarkdowndocumenting","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenisn%2Fmarkdowndocumenting/lists"}