typedoc
mkdocs-material
Our great sponsors
typedoc | mkdocs-material | |
---|---|---|
29 | 92 | |
7,284 | 17,838 | |
1.6% | - | |
9.2 | 9.8 | |
12 days ago | 7 days ago | |
TypeScript | HTML | |
Apache License 2.0 | 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.
typedoc
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
Firstly, install Typedoc using npm:
- Document Playwright tests with typedoc
-
Prim+RPC: a bridge between JavaScript environments. Easy-to-understand, type-safe, transport-agnostic RPC/IPC for JavaScript, supporting callbacks, batching, file uploads, custom serialization, and more.
While the Prim+RPC server is expected to be JavaScript, I'd like to support other languages through JSON Schema. I wrote a tool that translates TypeDoc comments into RPC-specific documentation. My plan is to turn this result into JSON Schema that can be served with the Prim+RPC server. This means you can get typed suggestions (for instance, from an IDE that understands JSON Schema) when writing requests in JSON files (I wrote a little about this here, still a WIP). From this, you could use your favorite HTTP client in the language of your choice, like but still benefit from having typed requests.
-
What software do you use to write documentation?
Docusaurus has a Typedoc plugin. Also there is a typedoc markdown plugin.
-
Mastering JSDoc: the complete guide for Javascript developers
Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it.
-
Opinionated standards for JSDoc
Since you're using TypeScript, use TypeDoc.
-
How to create and publish a TypeScript library with ease
Generates HTML documentation using TypeDoc.
-
I created a game engine using TypeScript. Please roast it.
I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools?
-
Complete rewrite of ESLint (GitHub discussion by the creator)
TSDoc is more consistent, has cleaner documentation, better tooling (e.g. TypeDoc or ESLint plugin) and better support for data structures (e.g. straightforward enums support).
-
How to properly document components
JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.
mkdocs-material
-
The Open Source Sustainability Crisis
https://squidfunk.github.io/mkdocs-material/
I'm an 'outsider', but from from the outside the Material For MkDocs Project looks like a very well managed open source project.
Martin Donath's project uses a 'sponsorware' release strategy to generate donations.
From my vantage point it seems to be working pretty well.
- Agora a nossa Megathread possui um novo visual!
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Wow, what is up with the material mkdocs theme (https://squidfunk.github.io/mkdocs-material/)? That's an extremely spiffy landing page, especially given that it's for a theme designed for a totally separate piece of software.
- Koji projekat na Githubu vas je odusevio u zadnje vreme?
-
MkDocs Publisher as an alternative for official Obsidian publish.
I was considering Pelican at some stage, but MkDocs has a great mobile friendly theme (Material for MkDocs) that is part of the dependencies. This theme and my previous experience in using MkDocs, gave me a clear answer what to use. There were also some other MkDocs plugins, that I was considering to use before I started to develop my bundle, but they were lacking in some elements (like plugin for wikilinks not working correctly for Obsidian links and one for callouts with small problems in embedded callouts, etc.). Finally, I didn't use those plugins, but they were good source to take a look at the code and get some inspiration, etc. (most of those plugins will mentioned in documentation in credits section, that is under construction). If you will ever have some features requests, just create an issue in git repo of the project. I'm open to suggestions how to extend functionality ot this project.
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Anyone know of a free dev docs like confluence?
Maybe something like https://squidfunk.github.io/mkdocs-material/ or https://www.bookstackapp.com/ ?
-
Public API documentation. What to use?
I use a combo of swagger and mkdocks: https://squidfunk.github.io/mkdocs-material/
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
What are some alternatives?
tsdoc - A doc comment standard for TypeScript
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
MkDocs - Project documentation with Markdown.
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
VuePress - 📝 Minimalistic Vue-powered static site generator
Read the Docs - The source code that powers readthedocs.org
mike - Manage multiple versions of your MkDocs-powered documentation via Git
furo - A clean customizable documentation theme for Sphinx
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
river-runner - Uses USGS/MERIT Basin data to visualize the path of a rain droplet to its endpoint.