A static HTML website generator for browsing C#, VB, MSBuild, and TypeScript source code with rich navigation features.
SourceBrowser is a static website generator that creates browsable HTML representations of source code repositories. It analyzes C#, VB, MSBuild, and TypeScript code using Roslyn to produce hyperlinked, syntax-highlighted HTML files, enabling web-based code exploration without an IDE. It solves the problem of making source code publicly accessible and navigable online, similar to reference documentation sites.
Developers and teams who want to publish their C#, VB, MSBuild, or TypeScript codebases as interactive websites for public or internal reference. It's particularly useful for open-source projects, documentation sites, and enterprises hosting internal code portals.
Developers choose SourceBrowser because it provides IDE-like navigation features (e.g., Go to Definition, Find All References) in a static website format, is built on reliable Microsoft tooling (Roslyn), and can be self-hosted. Its ability to handle multiple project types and generate fully linked HTML without a database simplifies deployment and maintenance.
Source browser website generator that powers https://source.dot.net, https://referencesource.microsoft.com and https://sourceroslyn.io
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates pre-calculated, hyperlinked HTML files with all navigation hardwired, minimizing server-side processing and enabling easy hosting of static content, as described in the 'Conceptual design' section.
Supports IDE-like features such as Go to Definition and Find All References for C#, VB, MSBuild, and TypeScript, allowing deep code exploration without a running IDE, per the 'Features' list.
Displays a merged project tree for multi-project solutions, making it easy to navigate complex codebases, as highlighted in the 'Features' section with the Solution Explorer.
Leverages Microsoft's Roslyn compiler platform for accurate code analysis, ensuring reliable syntax highlighting and cross-referencing, which is central to its design philosophy.
The generator is not incremental; you must regenerate the entire site from scratch for every update, which can be time-consuming for large projects, as noted in the 'Conceptual design' section.
Must be hosted at the root of a domain and requires an ASP.NET Core backend for search functionality, limiting deployment flexibility and adding server dependencies, as stated in the README's limitations.
Only supports C#, VB, MSBuild, and TypeScript; projects in other languages like Python or Java are not compatible, restricting its use to specific ecosystems.
Described as a reference implementation with no plans for significant updates, meaning users may face unaddressed bugs or lack new features, as per the 'Project status and contributions' section.