typedoc
obsidian-releases
typedoc | obsidian-releases | |
---|---|---|
30 | 1,654 | |
7,398 | 8,184 | |
1.3% | 5.0% | |
9.1 | 9.9 | |
6 days ago | 4 days ago | |
TypeScript | JavaScript | |
Apache License 2.0 | - |
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
-
90% less disk space + 80% faster doc generation w/ TypeDoc. Introducing the "Default Modern Theme" for TypeDoc + complete linkable API docs for the built-in TS lib declarations.
Background:The main bottleneck with the TypeDoc default theme especially for large projects is the verbose HTML for the left-hand navigation that linearly grows for each page based on the project size and consumes a massive amount of disk space; see this TypeDoc issue. The DMT caches the left-hand navigation HTML and dynamically creates a shared web component that is utilized across all pages only making a single copy of the navigation HTML. This reduces disk space utilization by up to 90% and also makes doc generation ~80% faster. I also include some style additions and replace the main search index generation using compressed MesssagePack instead of JSON which reduces the search index size by more than 90%.
-
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).
obsidian-releases
- Unlocking Efficiency: The Significance of Technical Documentation
-
UX Case Study: Markdown Heading
The closest editor that follows our first principle is Obsidian editor:
-
I switched from Notion to Obsidian
The solution was already installed on both my computer and my phone: Obsidian.
-
Why single vendor is the new proprietary
> why does open source need to "win"
Open source does not need to win.
But your ability to be in control of your computer needs to be preserved. A proprietary fridge cannot control your diet, while a proprietary App Store can control what software you install on YOUR phone (unless you live in EU, hello DMA!). The tail wags the dog, so to speak. Proprietary software has also been shown to break user workflows or remove functions in an update while leaving users with no choice whatsoever.
One alternative to having open source win is to ensure software must come with a robust warranty and other assurances you expect from the things you buy. EU's CRA will make software vulnerabilities in WiFi routers covered by warranty, for example.
You can also ensure robust and interoperable data storage options. For example, https://obsidian.md/ stores all notes in Markdown, not holding the data hostage in case users will not like how future versions will work. GDPR actually has a provision for data portability (Art. 20), but it does not seem to have a requisite effect on the industry yet.
And until the above issues are solved, open source remains the best way to ensure that a software tail cannot wag your computer dog.
-
Ask HN: Has Anyone Trained a personal LLM using their personal notes?
[2] https://obsidian.md/
-
Replatforming from Gatsby to Zola!
So I've had my fair share of personal websites and blogs. I have built them on stacks ranging from the most basic HTML and CSS, to hosted frameworks like Wordpress and Laravel, to the more modern single page applications built in Vue and React. For a simple content blog I think you can't go wrong with a Static Site Generator though. These days I am almost exclusively writing everything in Obsidian. Which is great because its all in standard markdown format. This allows for a really neat and easy content publishing workflow.
-
Show HN: Godspeed is a fast, 100% keyboard oriented todo app for Mac
Consider making an Obsidian[^1] plugin, or writing to Obsidian-compatible Markdown files :)
[^1]: https://obsidian.md/
-
Setting Up Obsidian for Content Planning and Project Management
Obsidian is a writing application created to allow for offline / private note taking in markdown format, in an interface that looks a lot like our regular programming IDE. It is very flexible, with a good collection of community plugins that you can use to customize Obsidian to your heart contents.
-
What is Omnivore and How to Save Articles Using this Tool
Obsidian support via our Obsidian Plugin
- Tools that Make Me Productive as a Software Engineer
What are some alternatives?
tsdoc - A doc comment standard for TypeScript
Trilium Notes - Build your personal knowledge base with Trilium Notes
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
QOwnNotes - QOwnNotes is a plain-text file notepad and todo-list manager with Markdown support and Nextcloud / ownCloud integration.
VuePress - 📝 Minimalistic Vue-powered static site generator
vimwiki - Personal Wiki for Vim
mkdocs-material - Documentation that simply works
TiddlyWiki - A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
docsify - 🃏 A magical documentation site generator.
AppFlowy - AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
Docusaurus - Easy to maintain open source documentation websites.
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.