Code Monkey home page Code Monkey logo

vdocfx's Introduction

VDocFx

Voltstro's fork of DocFx (v3).

Getting Started

  • Install .NET 7
  • Install latest vdocfx release:
dotnet tool update -g vdocfx --version "1.0.0-*" --add-source https://pkgs.dev.azure.com/Voltstro/VDocFx/_packaging/VDocFx/nuget/v3/index.json

Why

In November of 2022, Microsoft stopped developing v3 publicly, and started more heavily focusing on v2 for the public to use. That would normally be fine, but all of our docs already used v3, and VoltProjects was designed around using v3. So we forked it and created VDocFx.

There are three major down-sides to docfx v3.

  • Lack of tight integration with API doc generation
  • Lots of Microsoft Learn septic code
  • Usage of libraries that are not open-source, that come from Microsoft's Azure DevOps feed.

This fork fixes them (mostly, v2's API doc generation is arguably still better!).

License

Licensed under the MIT License.

vdocfx's People

Contributors

928pjy avatar adunndevster avatar angryberryms avatar bharney0 avatar bianyifan avatar byszhoubin avatar cuiyun01 avatar dependabot[bot] avatar fenxu avatar fkpwolf avatar freewheel70 avatar hejingkan2005 avatar herohua avatar huangmin-ms avatar jesong avatar lamebrain avatar live1206 avatar mingwli avatar osmondjiang avatar partychen avatar retyn avatar shanluo911 avatar superyyrrzz avatar tianqizhang avatar v-pegao avatar vicancy avatar voltstro avatar xiaofuhuang avatar xichan-ms avatar yufeih avatar

Stargazers

 avatar

Watchers

 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.