GithubHelp home page GithubHelp logo

davidjamesmarley / sharpdoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xoofx/sharpdoc

0.0 0.0 0.0 3.12 MB

SharpDoc is a documentation tool to generate HTML documentation for .NET projects

License: MIT License

C# 66.37% Java 1.53% CSS 12.80% JavaScript 18.88% Smalltalk 0.42%

sharpdoc's Introduction

SharpDoc is a documentation tool to generate HTML documentation for .NET projects.

An example documentation can be found at SharpDX Documentation

This documentation system is delivering a high quality documentation and fully generated class API reference. Current features are:

  • Generates Class API Reference from .NET assemblies and XML documentation file
  • Fully template based system using the simple and powerfull Razor template engine. Develop your page using cshtml, css, Javascript and C#
  • Easily stylable, customizable, overridable
  • Clean Class Library Reference generated from assemblies, using JavaScript and CSS for a better user experience
  • Support for namespace and assembly documentation
  • Support for custom user topics and table of contents
  • Links to MSDN .NET documentation
  • Easier to maintain and faster than Sandcastle

TODO: Add more information on usage

sharpdoc's People

Contributors

xoofx avatar tomspilman avatar florian-x avatar xen2 avatar robmaister avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.