DocFX
jQuery
DocFX | jQuery | |
---|---|---|
18 | 166 | |
3,889 | 58,906 | |
0.9% | 0.2% | |
9.8 | 8.5 | |
3 days ago | 4 days ago | |
C# | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
DocFX
-
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/window...
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 by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!
-
Use Case Driven Development with Low-Code
Tools like DocFx provide the ability to display the programmable functions in HTML pages. They are used with the following commands in the docfx folder:
-
Anybody know if there's a library for the doc engine that MS Docs/Learn uses?
AFAIK they use https://github.com/dotnet/docfx which can be too heavy for your case. We use mdBook for internal documentation (plain .md with mermaid plugin) and then serve it at docs.yourdevenv.com.
- Is there a simple way to auto-generate a wiki / documentation for project code that pulls from comments or <summary> tags?
-
What the latest tool to generate website docs from /// summary comments?
DocFX is a nice solution.
-
How to build a solution like docs.microsoft.com
It uses DocFX
-
Comments in Javascript
Some of the standard and well-maintained Tools for Comments are JSDoc for Javascript, DocFx for .NET, and JavaDoc for Java.
-
What Does Microsoft Use to Create their KB Articles?
Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/
-
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.
jQuery
-
How to Create an Auto-typing Feature in JavaScript
In this article, we will implement the auto typing feature using JavaScript and jQuery, as shown in the video below.
-
8 NPM Packages for JavaScript Beginners [2024][+tutorials]
Cheerio is your ticket to the world of server-side magic, allowing you to manipulate HTML and XML documents with jQuery-like syntax. It’s perfect for web scraping, data extraction, or just making sense of the mess that is web content. With Cheerio, you get to play around with the DOM, use CSS selectors, and basically do all the cool things you'd do in the browser, but server-side.
- Ask HN: Tips to get started on my own server
- jQuery v4.0.0 Beta
-
A step-by-step guide: How to create and publish an NPM package.
NPM packages include a wide range of tools such as frameworks like Express or React, libraries like jQuery, and task runners such as Gulp, and Webpack.
- jQuery 4.0.0 is finished, pending official release
-
TSDocs.dev: type docs for any JavaScript library
Great reference.
To this date, one of the best well-documented code is jQuery: https://github.com/jquery/jquery/blob/main/src/core/init.js
I learned a lot from looking into the code.
- What's New in jQuery 4.0
- jQuery 4.0 99% Complete
What are some alternatives?
Sandcastle - Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
Alpine.js - A rugged, minimal framework for composing JavaScript behavior in your markup.
MkDocs - Project documentation with Markdown.
Tailwind CSS - A utility-first CSS framework for rapid UI development.
Swashbuckle - Seamlessly adds a swagger to WebApi projects!
cash - An absurdly small jQuery alternative for modern browsers.
DocNet - Your friendly static documentation generator, using markdown files to build the content.
lodash - A modern JavaScript utility library delivering modularity, performance, & extras.
SharpDox
Alpine
F# Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)
TypeScript - TypeScript is a superset of JavaScript that compiles to clean JavaScript output.