docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254

Bot releases are hidden (Show)

docfx - Version 2.16.1

Published by qinezh over 7 years ago

  1. bug fix for model restore.
docfx - Version 2.16

Published by qinezh over 7 years ago

  1. Support the latest csproj format <Project Sdk="Microsoft.NET.Sdk">
    1. The latest csproj introduces in a new property TargetFrameworks, docfx does not support it for now. To make docfx work, please specify TargetFramework when calling docfx. A sample docfx.json would be as follows. The merge command is to merge YAML files generated with different TargetFramework into one YAML file.
    {
        "metadata": [
            {
                "src": "*.csproj",
                "dest": "temp/api/netstandard1.4",
                "properties": {
                    "TargetFramework": "netstandard1.4"
                }
            },
            {
                "src": "*.csproj",
                "dest": "temp/api/net46",
                "properties": {
                    "TargetFramework": "net46"
                }
            }
        ],
        "merge": {
            "content": [
                {
                    "files": "*.yml",
                    "src": "temp/api/netstandard1.4"
                },
                {
                    "files": "*.yml",
                    "src": "temp/api/net46"
                }
            ],
            "fileMetadata": {
                "platform": {
                    "temp/api/netstandard1.4/*.yml": [
                        "netstandard1.4"
                    ],
                    "temp/api/net46/*.yml": [
                        "net46"
                    ]
                }
            },
            "dest": "api"
        },
        "build": {
            "content": [
                {
                    "files": [
                        "api/*.yml",
                        "**.md",
                        "**/toc.yml"
                    ]
                }
            ],
            "dest": "_site"
        }
    }
    
docfx - Version 2.15.5

Published by qinezh over 7 years ago

  1. Fill metadata into Reference as expand Output only consumes its own PageViewModel.
  2. Fix # in the end of heading is missing.
docfx - Version 2.15.4

Published by qinezh over 7 years ago

  1. Switch to legacy markdown engine as default:
    1. Rename new markdown engine to dfm-latest and dfm-2.15.
    2. add back legacy markdown engine to dfm and dfm-2.13.
      Markdown engine can be switch by command line option markdownEngineName or docfx.json, see document.
docfx - Version 2.15.3

Published by qinezh over 7 years ago

  1. Log duplicate uids warning with DuplicateUids code.
docfx - Version 2.15.2

Published by qinezh over 7 years ago

  1. Bug fixes:
    1. Markdown html should not match inline html element.
docfx - Version 2.15.1

Published by qinezh over 7 years ago

  1. Bug fixes:
    1. Fix markdown list with tab indent.
    2. Support escaped pipe in table.
docfx - Version 2.15

Published by qinezh over 7 years ago

  1. Bug fixes:
    1. Auto dedent the included code snippet, both when including the whole file and file sections.
    2. [Breaking Change]For inline inclusion, trim ending white spaces, considering ending white spaces in inline inclusion in most cases are typos.
docfx - Version 2.14.1

Published by qinezh over 7 years ago

  1. fix bug in markdown list.
docfx - Version 2.14

Published by qinezh over 7 years ago

  1. Bug fixes:
    1. Fix duplicate project references fail GetCompilationAsync. https://github.com/dotnet/docfx/issues/1414
docfx - Version 2.13.2

Published by qinezh over 7 years ago

  1. fix null reference exception when content is empty
docfx - Version 2.13.1

Published by qinezh over 7 years ago

  1. fix the perf issue introduced from reporting toc metadata dependency.
  2. fix path too long issue.
docfx - Version 2.13

Published by qinezh over 7 years ago

  1. Breaking Change: Create new type for files in manifest.
  2. Support working folder for dfm include and code.
  3. Upgrade YamlDotNet to 4.1.
  4. Support cross file definition reference for swagger.
  5. Bug fixes:
    1. Filter config file is expected in working dir instead of project's dir/src dir.
    2. Create msbuild workspace with release configuration by default. https://github.com/dotnet/docfx/pull/1356
docfx - Version 2.12.1

Published by qinezh over 7 years ago

  1. Bug fixes: clickable images links in markdown topics are no longer being rendered correctly.
docfx - Version 2.12

Published by qinezh over 7 years ago

  1. Bug fixes:
  2. default template: Do not load search-worker.js when search is disabled in docfx.js
  3. C# region support for code snippets broken by #endregion with extra text. https://github.com/dotnet/docfx/issues/1200
  4. Markdown list continue with def.
  5. Markdown link rule is not allowed in link text.
  6. Markdown list restore wrong context.
  7. Metadata _docfxVersion can't be overwritten. https://github.com/dotnet/docfx/issues/1251
  8. statictoc template out of sync with default template. https://github.com/dotnet/docfx/issues/1256
  9. Fix footer covering sidetoc. https://github.com/dotnet/docfx/issues/1222
docfx - Version 2.11.3

Published by qinezh over 7 years ago

  1. Add support for title attribute specification in TOC.md files
docfx - Version 2.11.2

Published by qinezh almost 8 years ago

  1. Fix bug in functions exported by embedded common template.
docfx - Version 2.11.1

Published by qinezh almost 8 years ago

docfx - Version 2.11

Published by qinezh almost 8 years ago

  1. Export custom href generator.
  2. Use attribute driven data model for ManagedReference
  3. Bug fixes:
  4. Generate overload name/fullname form generic method should not contain method parameter.
  5. Fix href for markdown link to non-exist files in include files.
docfx - Version 2.11(Pre-Release)

Published by qinezh almost 8 years ago

  1. Export custom href generator.
  2. Bug fixes:
  3. Generate overload name/fullname form generic method should not contain method parameter.
  4. Fix href for markdown link to non-exist files in include files.
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted