[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-10279":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":17,"stars30d":18,"stars90d":16,"forks30d":16,"starsTrendScore":18,"compositeScore":19,"rankGlobal":10,"rankLanguage":10,"license":20,"archived":21,"fork":21,"defaultBranch":22,"hasWiki":21,"hasPages":23,"topics":24,"createdAt":10,"pushedAt":10,"updatedAt":30,"readmeContent":31,"aiSummary":32,"trendingCount":16,"starSnapshotCount":16,"syncStatus":17,"lastSyncTime":33,"discoverSource":34},10279,"docfx","dotnet\u002Fdocfx","dotnet","Static site generator for .NET API documentation.","https:\u002F\u002Fdotnet.github.io\u002Fdocfx\u002F",null,"C#",4431,886,145,405,0,2,6,66.44,"MIT License",false,"main",true,[25,26,27,7,28,29],"api","csharp","documentation","markdown","static-site-generator","2026-06-12 04:00:49","# Build your docs with docfx\n\n[![NuGet](https:\u002F\u002Fimg.shields.io\u002Fnuget\u002Fv\u002Fdocfx)](https:\u002F\u002Fwww.nuget.org\u002Fpackages\u002Fdocfx)\n[![ci](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Factions\u002Fworkflows\u002Fci.yml\u002Fbadge.svg)](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Factions\u002Fworkflows\u002Fci.yml)\n[![nightly](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Factions\u002Fworkflows\u002Fnightly.yml\u002Fbadge.svg)](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Factions\u002Fworkflows\u002Fnightly.yml)\n[![Help Wanted](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues\u002Fdotnet\u002Fdocfx\u002Fhelp-wanted?label=help-wanted)](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Flabels\u002Fhelp-wanted)\n[![Ask DeepWiki](https:\u002F\u002Fdeepwiki.com\u002Fbadge.svg)](https:\u002F\u002Fdeepwiki.com\u002Fdotnet\u002Fdocfx)\n\n* [Getting Started](#getting-started)\n* [Contributing](#contributing)\n* [Roadmap](#roadmap)\n* [License](#license)\n* [.NET Foundation](#net-foundation)\n\nBuild your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.\n\n---\n\nAs you may have heard docfx has been transitioned to be a .NET Foundation project. Microsoft Learn no longer uses docfx and do not intend to support the project since Nov 2022.\n\nDocfx is planned to continue as a community-driven project. We hope to produce future releases with new features and enhancements to support existing and new use cases. We also would like to invite any interested parties to be involved in this project. If you'd like to contact the community team please open a discussion thread.\n\n## Getting Started\n\n1. Install docfx as a global tool:\n\n    ```bash\n    dotnet tool install -g docfx\n    ```\n\n2. Create and start a website locally:\n\n   ```\n   docfx init -y\n   docfx build docfx_project\\docfx.json --serve\n   ```\n\n3. Go to https:\u002F\u002Flocalhost:8080 to see the sample site.\n\nFor more information, refer to [Getting Started](http:\u002F\u002Fdotnet.github.io\u002Fdocfx\u002Ftutorial\u002Fdocfx_getting_started.html).\n\n> [!TIP]\n> Docfx publishes nightly builds to [GitHub Packages](https:\u002F\u002Fgithub.com\u002Forgs\u002Fdotnet\u002Fpackages), this allows you to stay up-to-date with the latest developments in Docfx.\n\n## Contributing\n\nUse [Discussions](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fdiscussions) for questions and general discussions. \nUse [Issues](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fissues) to report bugs and proposing features.\n\nWe welcome code contributions through pull requests, issues tagged as **[`help-wanted`](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Flabels\u002Fhelp-wanted)** are good candidate to start contributing code.\n\n### Prerequisites\n\n- Install [Visual Studio 2022 (Community or higher)](https:\u002F\u002Fwww.visualstudio.com\u002F) and make sure you have the latest updates.\n- Install [.NET SDK](https:\u002F\u002Fdotnet.microsoft.com\u002Fdownload\u002Fdotnet) 8.x and 9.x.\n- Install NodeJS (24.x.x).\n\n### Build and Test\n\n- Build site templates in `templates` directory:\n  - Run `npm install` to restore npm dependencies.\n  - Run `npm run build` to build the templates.\n- Run `dotnet build` to build the project or use Visual Studio to build `docfx.sln`.\n- Run `dotnet test` to test the project or use Visual Studio test explorer.\n  - Run `git lfs checkout` to checkout files for snapshot testing\n\n### Branch and Release\n\nThe `main` branch is the default branch for pull requests and most other development activities. We occasionally use `feature\u002F*` branches for epic feature development.\n\nReleases are based on a stable `main` branch commit using [GitHub Releases](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Freleases). Use of [Conventional Commit](https:\u002F\u002Fwww.conventionalcommits.org\u002Fen\u002Fv1.0.0\u002F) is encouraged.\n\nDocfx is _not_ released under a regular cadence, new versions arrive when maintainers see enough changes that warrant a new releases. Sometimes we use prereleases to dogfood breaking changes and get feedbacks from the community.\n\n## Roadmap\n\nWe use [Milestones](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fmilestones) to communicate upcoming changes docfx:\n\n- [Working Set](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fmilestone\u002F48) are features being actively worked on. Not every features in this bucket will be committed in the next release but they reflect top of minds of maintainers in the upcoming period.\n\n- [Backlog](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fmilestone\u002F49) is a set of feature candidates for some future releases, but are not being actively worked on.\n\n## License\n\nThis project is licensed under the [MIT](https:\u002F\u002Fgithub.com\u002Fdotnet\u002Fdocfx\u002Fblob\u002Fmain\u002FLICENSE) License.\n\n## .NET Foundation\n\nThis project is supported by the [.NET Foundation](http:\u002F\u002Fwww.dotnetfoundation.org).\n\nThis project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.\nFor more information see the [.NET Foundation Code of Conduct](https:\u002F\u002Fdotnetfoundation.org\u002Fcode-of-conduct).\n","dotnet\u002Fdocfx 是一个用于生成 .NET API 文档的静态网站生成器。它支持从 Markdown 文件和 API 注释中生成高质量的技术文档，并提供丰富的主题和模板来定制外观。docfx 通过解析源代码自动生成 API 参考文档，支持多种格式如 .NET、REST API 等。适用于需要构建技术文档站点的开发者或团队，特别是那些希望为自己的 .NET 库或应用程序创建详尽文档的人。项目采用 MIT 许可证开源，拥有活跃的社区支持与贡献渠道。","2026-06-11 03:27:35","top_topic"]