Software Alternatives & Reviews

DocFX VS Compodoc

Compare DocFX VS Compodoc and see what are their differences

DocFX logo DocFX

A documentation generation tool for API reference and Markdown files!

Compodoc logo Compodoc

The missing documentation tool for your Angular application
  • DocFX Landing page
    Landing page //
    2023-05-11
  • Compodoc Landing page
    Landing page //
    2021-11-02

DocFX

Categories
  • Documentation
  • Documentation As A Service & Tools
  • Knowledge Base
  • Internal Knowledgebase
Website dotnet.github.io
Details $

Compodoc

Categories
  • Documentation
  • Documentation As A Service & Tools
  • Knowledge Base
  • Knowledge Management
Website compodoc.app
Details $

DocFX videos

Generate Java documentation with DocFX

Compodoc videos

NestJS Crash Course 05 | Documenting our REST API with Swagger and Compodoc

Category Popularity

0-100% (relative to DocFX and Compodoc)
Documentation
56 56%
44% 44
Documentation As A Service & Tools
Knowledge Base
50 50%
50% 50
Development
73 73%
27% 27

User comments

Share your experience with using DocFX and Compodoc. For example, how are they different and which one is better?
Log in or Post with

Social recommendations and mentions

Compodoc might be a bit more popular than DocFX. We know about 10 links to it since March 2021 and only 7 links to DocFX. We are tracking product recommendations and mentions on various public social media platforms and blogs. They can help you identify which product is more popular and what people think of it.

DocFX mentions (7)

  • TSDocs.dev: type docs for any JavaScript library
    This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 4 months ago
  • What Does Microsoft Use to Create their KB Articles?
    Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: about 2 years ago
  • Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?
    We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago
  • CSharp Docuementation Site
    I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago
  • What platform is Microsoft Docs hosted on?
    My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: over 2 years ago
View more

Compodoc mentions (10)

  • Documentation culture
    Properly written code, there are documentation tool like this for Angular and others. Https://compodoc.app/. Source: over 1 year ago
  • Are there any Angular Modules, components, services relationship Mapping tools? Apart from Angular Augury.
    Compodoc is a good tool for generating docs for an angular project. The documents generated also includes visual maps of dependencies. Source: over 1 year ago
  • I write more documents than code, but it comes with its struggles. Do you feel the same?
    App documentation, here is compodoc (https://compodoc.app/) It is generated when the dev does a git commit and build in the pipeline. Source: over 1 year ago
  • πŸš€ Angular 14 + ESLint, Material + Transloco + Jest, TestCafe + Docker + Prettier πŸš€
    βœ… Angular 14 βœ… Angular Material βœ… Unit Testing with Jest βœ… End-to-End Testing with TestCafΓ© βœ… Internationalization with Transloco βœ… Auto documentation with Compodoc βœ… Analyse your project with source-map-explorer βœ… Docker βœ… ESLint βœ… Prettier βœ… Commit Linting. - Source: dev.to / over 1 year ago
  • Documenting Angular projects
    Finally, we have come to a point where we want our JSDoc comment documentations to turn into a full scale documentation website, which we can share with new developers instead of providing lengthy Word documents, or which can be used by the team to search for explanations and direction during development. Thankfully, there are amazing tools that help us build such sites easily, with just a console command. Today... - Source: dev.to / over 1 year ago
View more

What are some alternatives?

When comparing DocFX and Compodoc, you can also consider the following products

Doxygen - Generate documentation from source code

TypeDoc - A documentation generator for TypeScript projects

Docsify.js - A magical documentation site generator.

Daux.io - Daux.io is a documentation generator that uses a simple folder structure and Markdown files to...

swagger.io - Swagger is an open source RESTapi Documentation Tool.

Natural Docs - Natural Docs is an open-source documentation generator for multiple programming languages.