{"id":13415130,"url":"https://github.com/EWSoftware/SHFB","last_synced_at":"2025-03-14T22:32:51.763Z","repository":{"id":26199497,"uuid":"29645643","full_name":"EWSoftware/SHFB","owner":"EWSoftware","description":"Sandcastle Help File Builder (SHFB).  A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.","archived":false,"fork":false,"pushed_at":"2024-09-21T17:08:56.000Z","size":34890,"stargazers_count":2193,"open_issues_count":17,"forks_count":369,"subscribers_count":130,"default_branch":"master","last_synced_at":"2024-10-29T15:10:56.435Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EWSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2015-01-22T02:40:10.000Z","updated_at":"2024-10-29T04:09:00.000Z","dependencies_parsed_at":"2024-01-17T04:26:45.914Z","dependency_job_id":"0b8dc5ae-59f9-4a40-b313-c1712ccc6f60","html_url":"https://github.com/EWSoftware/SHFB","commit_stats":{"total_commits":377,"total_committers":43,"mean_commits":8.767441860465116,"dds":0.4694960212201591,"last_synced_commit":"2aea03b93543920d15a31d7ec7a4e5814ce99ad1"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EWSoftware%2FSHFB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EWSoftware%2FSHFB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EWSoftware%2FSHFB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EWSoftware%2FSHFB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EWSoftware","download_url":"https://codeload.github.com/EWSoftware/SHFB/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243324486,"owners_count":20273111,"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":[],"created_at":"2024-07-30T21:00:43.804Z","updated_at":"2025-03-14T22:32:51.757Z","avatar_url":"https://github.com/EWSoftware.png","language":"C#","readme":"Welcome to the **Sandcastle Help File Builder** project.\r\n\r\n* [Get the current release](https://github.com/EWSoftware/SHFB/releases)\r\n* [Ask a question or open an issue](https://github.com/EWSoftware/SHFB/issues)\r\n* [Frequently Asked Questions (FAQ)](http://ewsoftware.github.io/SHFB/html/1aea789d-b226-4b39-b534-4c97c256fac8.htm)\r\n* [Sandcastle Help File Builder Help](http://EWSoftware.github.io/SHFB)\r\n* [Sandcastle MAML Guide](http://EWSoftware.github.io/MAMLGuide)\r\n* [Sandcastle XML Comments Guide](http://EWSoftware.github.io/XMLCommentsGuide)\r\n\r\nThis project is composed of two separate parts that work together: the Sandcastle tools and the Sandcastle Help\r\nFile Builder.  The Sandcastle tools are used to create help files for managed class libraries containing both\r\nconceptual and API reference topics.  API reference topics are created by combining the XML comments that are\r\nembedded in your source code with the syntax and structure of the types which is acquired by reflecting against\r\nthe associated .NET Framework assemblies.  Conceptual topics are created by converting XML documents that you\r\nauthor containing Microsoft Assistance Markup Language (MAML).  The Sandcastle tools are command-line based and\r\nhave no GUI front-end, project management features, or an automated build process.\r\n\r\nThe Sandcastle Help File Builder was created to fill in the gaps, provide the missing NDoc-like features that\r\nare used most often, and provide standalone GUI and command line based tools to build a help file in an\r\nautomated fashion.  A Visual Studio integration package is also available for it so that help projects can be\r\ncreated and managed entirely from within Visual Studio.\r\n\r\nSandcastle was originally created by Microsoft back in 2006.  The last official release from Microsoft occurred\r\nin June 2010.  Until October 2012, it was hosted at the Sandcastle project site on CodePlex.  In October 2012,\r\nMicrosoft officially declared that they were ceasing support and development of Sandcastle.  The Sandcastle\r\ntools have been merged into the Sandcastle Help File Builder project and all future development and support for\r\nthem will be handled at this project site.\r\n\r\nSee the [Installation Instructions](http://EWSoftware.GitHub.io/SHFB/html/8c0c97d0-c968-4c15-9fe9-e8f3a443c50a.htm)\r\nfor information about the required set of additional tools that need to be installed, where to get them, and how\r\nto make sure everything is configured correctly.  The guided installer also provides information on the\r\nnecessary tools and walks you through the installation steps.\r\n\r\nIf you are new to Sandcastle and the help file builder, see the topics in the\r\n[Getting Started](http://EWSoftware.GitHub.io/SHFB/html/b772e00e-1705-4062-adb6-774826ce6700.htm) section to get\r\nfamiliar with it, set up your projects to produce XML comments, and create a help file project.\r\n\r\nSee the [Project Wiki](https://github.com/EWSoftware/SHFB/wiki) for information on requirements for building the\r\ncode, contributing to the project, and links to other useful topics.\r\n","funding_links":[],"categories":["Documentation","文档","C\\#","C#","C# #","Language-Specific Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEWSoftware%2FSHFB","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEWSoftware%2FSHFB","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEWSoftware%2FSHFB/lists"}