docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254

Bot releases are visible (Hide)

docfx - Version 2.22

Published by qinezh about 7 years ago

  1. Support REST extensibility by rest.tagpage and rest.operationpage plugins, to split the original REST API page into smaller pages. Refer to plugins dashboard for more details.
  2. Bug fixed:
    1. Fix _rel unfound when href is url decoded.
    2. Fix #1886: Fails when project doesn't contain git remote information.
    3. Fix toc restruction to support expand child by sequence.
    4. Ignore default plugged assemblies when loading plugins.
docfx - Version 2.21.2

Published by qinezh over 7 years ago

  1. Allow manual define heading id:

    # <a id="a"></a>B
    

    will generate following html:

    <h1 id="a">B</h1>
    
  2. Bug fixes:

    1. Ignore default plugged assemblies when loading plugins.
docfx - Version 2.21.1

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. Fix bug in tabbed content.
docfx - Version 2.21

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. Fix bug in tabbed content.
docfx - Version 2.20

Published by vicancy over 7 years ago

  1. Add anchor links to default theme.
  2. Disable LRU cache as it has race condition bug and not easy to fix.
  3. PDF improvements:
    1. Intermediate html files are now removed by default, you can use --keepRawFiles option to keep them.
    2. Add syntax highlight to PDF, it is using highlight.js in client-side js.
    3. Add hook files to css and js, you can now customize PDF styles by adding your own main.css and main.js.
  4. Change the default behavior of incremental build that it is always based on the same cache folder (originally the cache folder changes in every build and copy historical files form last cache folder). You can use --cleanupCacheHistory option to cleanup the historical cache data.
  5. Bug fixes:
    1. Fix #1817: Error extracting metadata when containing constant surrogate unicode character.
    2. Fix #1655: Using hashtag in external cross reference broken.
    3. Fix #219: Fails when source code contains two type names that differ only in case
    4. Fix #164: Clean up previous auto-generated metadata YAML files when calling docfx metadata
    5. Fix #1797: the command docfx template list does not show the pdf template
    6. Fix #1803: Overriding example with *content in same file as other overrides doesn't work
    7. Fix #1807: XREF link to API doc with wildcard UID not getting generated
    8. Fix #1823: Metadata being generated from referenced projects
    9. FIx #1824: Change generated .manifest file to be indented and ordered.
docfx - Version 2.19.2

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. ignore exception when saving cache.
    2. fix html tag in markdown.
docfx - Version 2.19.1

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. ignore exception when saving cache.
    2. fix html tag in markdown.
docfx - Version 2.19

Published by qinezh over 7 years ago

  1. Enable incremental Build by default. You can use option --force to force rebuild.
  2. Improve docfx metadata error message when error opening solutions or projects using Roslyn. https://github.com/dotnet/docfx/pull/1738
  3. Support more develop language for code snippet Markdown syntax. https://github.com/dotnet/docfx/pull/1754
  4. Downgrade the message level for invalid inline code snippet and invalid block file inclusion from Error to Warning.
  5. Add LogCode for each file to the manifest file.
  6. DocFX is NOT dependent on Build Tool 2015 anymore.
  7. Add line and source file info for invalid cross reference
  8. Bug fixes:
    1. Fix html pre element behavior in Markdown, empty lines are now allowed in <pre> blocks.
    2. Fix #1747: add app.config redirect binding to docfx to resolve LoaderException for docfx metadata
    3. Fix #1737: it is now possible to use > [!warning] format in triple-slash comments
    4. Fix #1319 that docfx fails to load multiple solutions
    5. Fix #1720 and #1708 that docfx throws runtime error in Mono
    6. Fix post processor incremental bug: restore manifest should be case-insensitive
docfx - Version 2.18.5

Published by qinezh over 7 years ago

  1. Log WorkspaceFail events so that we get more detailed information what's wrong when opening solutions or projects using Roslyn.
docfx - Version 2.18.4

Published by qinezh over 7 years ago

  1. Fix #1747: Add app.config redirect binding to docfx to resolve LoaderException for docfx metadata
docfx - Version 2.18.3

Published by qinezh over 7 years ago

  1. Remove dependency to Build Tool 2015
  2. Fix runtime error when running in Mono: https://github.com/dotnet/docfx/issues/1720, https://github.com/dotnet/docfx/issues/1708
docfx - Version 2.18.2

Published by qinezh over 7 years ago

  1. PDF is now supported. Refer to Walkthrough: Generate PDF to get start with generating PDF files.

  2. Fix default template performance bug that local search is always used.

docfx - Version 2.18.1

Published by qinezh over 7 years ago

  1. Bug fixes:
    1. Bug fix for markdown empty link.
    2. Bug fix for html behaivor in dfm-latest.
docfx - Version 2.17.7

Published by qinezh over 7 years ago

docfx - Version 2.17.4

Published by qinezh over 7 years ago

  1. Bug fix for default template that inheritance is incorrect
docfx - Version 2.17.3

Published by qinezh over 7 years ago

  1. Bug fix for extracting metadata from assembly that XML comment is not applied.
docfx - Version 2.17.2

Published by qinezh over 7 years ago

  1. Bug fix for template statictoc.
docfx - Version 2.17.1

Published by qinezh over 7 years ago

  1. Bug fix for fail to init markdown style.
docfx - Version 2.17

Published by qinezh over 7 years ago

  1. Introduce Master page syntax into Template System:

    1. Mustache: {{!master('<master_page_name>')}}
    2. Liquid: {% master <master_page_name> %}
  2. [Breaking Change] View model for ManagedReference.html.primary.tmpl is updated from {item: model} to model, if you overwrites ManagedReference.html.primary.tmpl in your own template, make sure to re-export the template file.

  3. Simplify default template: now you only need to overwrite _master.tmpl to redesign the layout for the website.

  4. Frontend improvement

    1. Long namespace name in TOC will be word-wrapped now
    2. Bug fix for docfx.js when navbarPath or tocPath is empty.
docfx - Version 2.16.8

Published by qinezh over 7 years ago

  1. Add a Container enum to MemberType
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted