MkDocs
Doxygen
GitBook
Docusaurus
Daux.io
ReadTheDocs
Docsify.js
DocFX
JSDoc
Doxygen
JSOLint
Swagger UI
DocFX
TypeDoc
JSONFormatter.org
Natural Docs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
MkDocsBased on our record, JSDoc seems to be a lot more popular than MkDocs. While we know about 48 links to JSDoc, we've tracked only 2 mentions of MkDocs. 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.
I'm a software engineer, and before getting my rM2, I kept all of my notes in Markdown format. They're under source control (git), and I use mkdocs to build them into a static website. I have a CI pipeline set up so that whenever I push changes to my notes to GitHub/Gitlab/Sourcehut, they are automatically built and published to my site. Source: about 1 year ago
Starlette is a web framework developed by the author of Django REST Framework (DRF), Tom Christie. DRF is such a solid project. Sharing the same creator bolstered my confidence that Starlette will be a well designed piece of software. - Source: dev.to / about 3 years ago
I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 2 months ago
The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 2 months ago
There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 3 months ago
JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / 3 months ago
Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and... - Source: dev.to / 6 months ago
Doxygen - Generate documentation from source code
GitBook - Modern Publishing, Simply taking your books from ideas to finished, polished books.
JSOLint - Format, verify, and lint JSON effortlessly with our powerful Validator Tool. Generate pretty JSON and validate online for free. Simplify your JSON tasks
Docusaurus - Easy to maintain open source documentation websites
Swagger UI - Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swag
Daux.io - Daux.io is a documentation generator that uses a simple folder structure and Markdown files to...
