{"repo":"maxtoroq/sandcastle-md","free":true,"listed":false,"github":"https://github.com/maxtoroq/sandcastle-md","clone":"git clone https://github.com/maxtoroq/sandcastle-md.git","description":"Converts your Sandcastle-generated HTML website to Markdown","language":"XSLT","stars":23,"topics":["sandcastle","markdown","api-reference","dotnet"],"license":"Apache-2.0","category":"productivity","readme_excerpt":"[sandcastle-md] — Your API reference on GitHub ============================================== sandcastle-md converts your [SHFB]-generated HTML website to Markdown. - Browse your API reference on GitHub.com or using any tool that supports Markdown - Host your API reference on GitHub Pages, using your own layout and fully integrated with your site Additionaly, sandcastle-md makes the following changes to SHFB's output: - Transforms the flat topic file structure to a hierarchical, one directory per namespace/type - Excludes topics that group members into categories e.g. Properties, Methods, Overloads, etc. - Includes the Overload List in each overloaded member's topic Project Settings ---------------- Open your SHFB project and make sure the following settings are in place: Build - Uncheck Clean intermediate files after a succesful build False - Uncheck Indent rendered HTML False Help File - Set Topic file naming method to Member name MemberName - Set Presentation Style to VS2013 VS2013 - Check Include root namespace container and set the title to something like <project name Namespaces True {Project Name} Namespaces Help 1/Website - Set Website SDK link type to Online links to MSDN help topics Converting to Markdown ---------------------- Build your SHFB project (if you haven't already): Restore NuGet packages and build sandcastle-md: Before executing it's recommended to clear any previous output, to make sure any deleted topics do not remain: Finally, execute: Examples ---","default_branch":null,"files":null,"tree":[],"storefront":"/r/maxtoroq","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/maxtoroq/sandcastle-md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}