mdBook
obsidian-releases
mdBook | obsidian-releases | |
---|---|---|
101 | 1,654 | |
16,802 | 8,056 | |
2.0% | 3.5% | |
8.6 | 9.9 | |
4 days ago | 6 days ago | |
Rust | JavaScript | |
Mozilla Public 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.
mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
- FLaNK Stack for 4th of July
- MdBook – A command line tool to create books with Markdown
- MdBook Create book from Markdown files. Like Gitbook but implemented in Rust
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?
gitbook - The open source frontend for GitBook doc sites
Trilium Notes - Build your personal knowledge base with Trilium Notes
MkDocs - Project documentation with Markdown.
QOwnNotes - QOwnNotes is a plain-text file notepad and todo-list manager with Markdown support and Nextcloud / ownCloud integration.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
vimwiki - Personal Wiki for Vim
bookdown - Authoring Books and Technical Documents with R Markdown
TiddlyWiki - A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
Docusaurus - Easy to maintain open source documentation websites.
AppFlowy - AppFlowy is an open-source alternative to Notion. You are in charge of your data and customizations. Built with Flutter and Rust.
rubigo
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.