docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254

Bot releases are visible (Hide)

docfx - Version 2.0.1

Published by qinezh over 8 years ago

  1. Fix bug that file links can't be resolved in overwrite file
docfx - Version 2.0

Published by qinezh over 8 years ago

  1. Breaking Change Add line info for markdown parser.
  2. Allow Markdown reference at the end of overwrite file.
  3. Provide more information for API reference documentation
  4. display inherited members
  5. display overridden members
  6. display implemented interface
  7. seperate category for Explicit Interface Implementation
  8. Rest api - Enable Tag in Swagger file to organize the APIs.
docfx - Version 1.9.4

Published by qinezh over 8 years ago

  1. Fix Bug that may cause missing exception type in API reference documentation.
docfx - Version 1.10.0-alpha

Published by qinezh over 8 years ago

Support .NET Command Line Interface Project

docfx - Version 1.9.3

Published by qinezh over 8 years ago

  1. Fix OP template for metadata.
docfx - Version 1.9.2

Published by qinezh over 8 years ago

  1. Fix OP template for metadata.
docfx - Version 1.9.1

Published by qinezh over 8 years ago

  1. Fix OP template.
docfx - Version 1.9

Published by qinezh over 8 years ago

  1. Breaking Change Refactor template system:

    1. The input data model now contains all the properties including system generated metadata starting with underscore _ and globally shared variables stored in __global. You can use docfx build --exportRawModel to view the data model.
    2. Preprocessor's transform function signature changes to:
    exports.transform = function (model){
        // transform the model 
        return model;
    }
    
  2. Provide a new embedded template statictoc with TOC generated in build time. Webpages generated by this template is PURE static and you can simply open the generated webpage file to take a preview, no local server is needed.

  3. Allow switch markdown engine.

  4. Allow export metadata to manifest file.

  5. Improve exclude logic to help avoid PathTooLongException. (https://github.com/dotnet/docfx/issues/156)

  6. Provide with a config file named search-stopwords.json to customise full-text search stop-words. (https://github.com/dotnet/docfx/issues/279)

  7. Bug fixes:

  8. Fix bug when cref contains loop. (https://github.com/dotnet/docfx/issues/289)

  9. Make sure id is unique for each HTML in markdown transforming. (https://github.com/dotnet/docfx/issues/224)

  10. Fix index range bugs in YamlHeaderParser. (https://github.com/dotnet/docfx/issues/265)

docfx - Version 1.8.4

Published by qinezh over 8 years ago

  1. Fix bug when outputFolder, basedirectory and destination are all not set
  2. fix <a> tag when href has invalid value with anchor
docfx - Version 1.8.3

Published by qinezh over 8 years ago

  1. Fix bug for [!include()[]] when multiple articles in different subfolder including one file that v1.8.2 not resolved
docfx - Version 1.8.2

Published by qinezh over 8 years ago

  1. Fix bug for [!include()[]] when multiple articles in different subfolder including one file
docfx - Version 1.8.1

Published by qinezh over 8 years ago

  1. Fix bug when serialize attribute argument for type array. (https://github.com/dotnet/docfx/issues/280)
  2. Fix bug when include file link to an anchor.
  3. Don't modify link when target file not existed.
docfx - Version 1.9.0-alpha-0091-g1c1b291

Published by qinezh over 8 years ago

Support .NET Command Line Interface Project

docfx - Version 1.8

Published by qinezh over 8 years ago

  1. Support multiple regions selection, code lines highlight and dedent length setting in Code Snippet. (https://github.com/dotnet/docfx/issues/189)
  2. Support more tags in triple-slash-comments, e.g. lang, list, code, paramref and typeparamref.
  3. Add Example section to default template.
  4. Bug fixes:
    1. Fix bug when parsing triple-slash-comments. (https://github.com/dotnet/docfx/issues/221)
    2. Fix syntax generation for VB module. (https://github.com/dotnet/docfx/issues/260)
docfx - Version 1.7.2

Published by qinezh over 8 years ago

  1. Fix markdown bug:
    • Ordered list continue with unordered list.
    • Support gfm comments.
docfx - Version 1.7.1

Published by qinezh over 8 years ago

  1. Fix markdown bug:
    • Do NOT apply inline rule for html code.
    • Update em rule for gfm.
docfx - Version 1.7

Published by qinezh over 8 years ago

  1. Behavior change
    1. For articles not in TOC, it's TOC file is the nearest TOC File in its output folder. Previously we only search the TOC File under the same input folder of the Not-In-Toc article.
  2. Provide more information for API reference documentation
    1. Type of events (https://github.com/dotnet/docfx/issues/217)
    2. Parameters/returns for delegates (https://github.com/dotnet/docfx/issues/218)
    3. Type parameter description (https://github.com/dotnet/docfx/issues/204)
  3. Cross-reference is now supporting anchor# (https://github.com/dotnet/docfx/issues/190)
  4. C# Code snippet now supports referencing source code using a region #engion (https://github.com/dotnet/docfx/issues/160)
  5. Support TOC reference. With this syntax, we can combine multiple TOC files into a single TOC. (https://github.com/dotnet/docfx/issues/161)
  6. Improve user experience when using docfx.msbuild in VS IDE
  7. Code refactor:
    1. We improved DocFX project structure in this release. Microsoft.DocAsCode.EntityModel namespace is no longer in use. Assemblies are separated into Microsoft.DocAsCode.Build, Microsoft.DocAsCode.DataContracts, and Microsoft.DocAsCode.Metadata namespace. All assemblies can be separately referenced through NuGet. In this way, it is much convenient for plugin writers to reference existing data models and utilities.
docfx - Version 1.6.2

Published by vicancy over 8 years ago

  1. For issue #221, add detailed error information.
docfx - Version 1.6.1

Published by vicancy over 8 years ago

v1.6.1

  1. Fix bug: "Improve this doc" button disppears in method level

v1.6

  1. Add attribute in c# and vb syntax.
  2. Support full text search, with pure client side implementation:
    1. The feature is disabled by default. You can enable it by adding "_enableSearch": true to the globalMetadata property of docfx.json.
    2. The search engine is powered by lunr.js
docfx - Version 1.5.2

Published by vicancy over 8 years ago

Revert breaking changes in template introduced in v1.5.1

Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted