Top 23 JavaScript Documentation Projects
-
Project mention: Recomendations to build a learning platform for a small company? | reddit.com/r/learnprogramming | 2022-01-11
After reading your post again and this comment, I don't think Jekyll is the best choice. Something like GitBook, MkDocs, or Docsify would be a better solution as they let you control the organization and flow much better.
-
electron-vue
An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.
It appears electron-vue, the leading Github repository that combines VueJS and Electron hasn't had a commit since April 21, 2021. Prior to the April 21st commits, it hasn't had serious contribution activity since December 3rd, 2019 and before that October 23, 2018.
-
OPS
OPS - Build and Run Open Source Unikernels. Quickly and easily build and deploy open source unikernels in tens of seconds. Deploy in any language to any cloud.
-
Project mention: Code for People, Not for Machines - A Glimps into my Newest Book | dev.to | 2022-01-18
Notice how the tooltips generated by the same code differ when a properly formatted comment is added into the mix. This is JavaScript code and the comments are following JSDocs standards. These standards tell you how to format your comments with a structure that a machine can then parse and get useful information out of. You clearly identify things such as variable types and names, return types, descriptions, and more, and then, in our case, the IDE parses it and show an informative tooltip.
-
API Link - apiDOC
-
-
Project mention: How can I use this comment feature of vscode to specify parameters and return values of a function? | reddit.com/r/vscode | 2021-05-28
Check out ESDoc
-
codecrumbs
Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.
-
SonarLint
Deliver Cleaner and Safer Code - Right in Your IDE of Choice!. SonarLint is a free and open source IDE extension that identifies and catches bugs and vulnerabilities as you code, directly in the IDE. Install from your favorite IDE marketplace today.
-
-
Documize
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS (by documize)
The Documize Community Github description states that content PDF export is a feature of the Community+ edition, which is available for download on their download page here as opposed to the Github release builds. If you indeed have more than 10 users, then you can't use Community+, so you won't have the ability to natively export content as PDF.
-
-
widdershins
OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown (by Mermade)
You can do both. Widdershins converts an OpenAPI definition to the markdown format used by Slatedocs. https://github.com/mermade/Widdershins
-
-
Project mention: How do you write your API documentation? Any self-hosted utilities you'd recommend? | reddit.com/r/node | 2021-05-21
On the Node.js framework side of things, Fastify has support for Swagger with the fastify-swagger plugin.
-
-
generator
Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!
This can be improved and extended overtime, especially because of the way the generator is designed, enabling extensibility so we can have templates for many other languages that support more protocols, etc. For example, there is only a NATS generator for .NET Core... but perhaps in the future there could be more protocols supported for .NET Core and examples built for Azure 😃.
-
Strapi Documentation Next.js documentation 10 Reasons you should use a Headless CMS
-
retype
Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.
Retype
-
This is my pull request for the second issue. Thanks to docusaurus-lunr-search, I have implemented the search bar for the site and I need to modify docusaurus.config.js file a bit by adding to the plugin array.
-
-
Project mention: emacs-docs: The documentation website Emacs deserves | reddit.com/r/planetemacs | 2021-12-01
-
-
itflow
Free Opensource ITGlue alternative - Client IT Documentation, Ticketing, Invoicing and Accounting Web Application for MSP (Managed Service Providers).
-
eventbridge-atlas
Open-source tool to document, discover, and share your Amazon EventBridge schemas.
Project mention: Use AWS EventBridge? I created some tools you might find interesting... | reddit.com/r/serverless | 2021-08-12
JavaScript Documentation related posts
- [For Hire] Full stack JS developer (Vue & Node)
- Building email signup form for Docusaurus with hCaptcha, Cloudflare Pages and Mailgun
- Recomendations to build a learning platform for a small company?
- What’s new in TypeScript 4.5
- 무작정 Markdown 으로 문서 사이트를 만들고 싶은 이들에게...
- MDS Newsletter #12
- Commenting Styles
Index
What are some of the best open-source Documentation projects in JavaScript? This list will help you:
| Project | Stars | |
|---|---|---|
| 1 | docsify | 19,560 |
| 2 | electron-vue | 14,683 |
| 3 | JSDoc | 12,629 |
| 4 | apiDoc | 9,235 |
| 5 | documentation.js | 5,456 |
| 6 | ESDoc | 2,710 |
| 7 | codecrumbs | 2,589 |
| 8 | dox | 2,142 |
| 9 | Documize | 1,463 |
| 10 | styledocco | 1,070 |
| 11 | widdershins | 1,019 |
| 12 | rabbitmq-website | 488 |
| 13 | fastify-swagger | 453 |
| 14 | Gitdown | 438 |
| 15 | generator | 409 |
| 16 | documentation | 340 |
| 17 | retype | 294 |
| 18 | docusaurus-lunr-search | 220 |
| 19 | jsdox | 205 |
| 20 | emacs-docs | 181 |
| 21 | handbook | 130 |
| 22 | itflow | 113 |
| 23 | eventbridge-atlas | 88 |
Are you hiring? Post a new remote job listing for free.
