mdBook
obsidian-git
Our great sponsors
mdBook | obsidian-git | |
---|---|---|
100 | 85 | |
16,669 | 5,806 | |
2.8% | - | |
8.6 | 8.2 | |
11 days ago | 13 days ago | |
Rust | TypeScript | |
Mozilla Public 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.
mdBook
- 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
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
obsidian-git
-
How to improve your GitHub vanity metrics FAST
In practice I write in Obsidian, the best thing since slice bread for me. And it was obsidian-git, running every 10 minutes or so, who was keeping my GitHub vanity metrics very green.
-
A structured note-taking app for personal use
> Joplin is using md to.
The way it's handled can make the difference in control.
> by separating that in their DB, it's a big NO for me since it's a closed silo.
Joplin is using a popular open database with a healthy community and good tooling. It's as open as markdown. Maybe not for you, when you lack the knowledge, but markdown is similar closed for anyone not understanding filesystems and editors.
> This: https://github.com/blacksmithgu/obsidian-dataview works so wonderful for me
Good for you, but that is very low level in terms of data-handling. Dataview is really just an elaborated search, there is no good level of interaction. Datacore, the next project of the Dataview is supposed to bring this, but it's not even usable yet AFAIK. Coincidental, the Obsidian-devs are also working on that front, but nothing is finished yet.
> https://github.com/denolehov/obsidian-git and b) easy to fix since it's a text file. Gosh!
That's useless when the app itself is not working. And even worse if you are not realizing the errors early.
> Aha. I don't think so. Which authority says that?
My own experience. I've tested enough plugins over the years to know their dark corners.
> And even if It's like that, my markdown files would survive everything
The thing is, technically you are not even having proper markdown, but a fork with some extensions of Obsidian. So some features of your parts might break when switching away from Obsidian. And the reason for all this is also because markdown is lacking definitions for what obsidian-people are doing with it. Coincidentally, this seems also one of the reasons why Joplin is using a database.
> And gosh, this is a good thing!
Not if they all suck.
> Installing multiple task plugins shows that something is "broke" on the user side.
Sure, because the plugins are lacking features, its the users fault... Maybe some users have just very different levels of requirements from you.
- Need some help: Obsidian/Obsidian Git can't sync/push to remote • "fatal: bad object refs/heads" and "conflicting files"
-
Obsidian 1.4.10 Desktop (Public)
The Obsidian team uses the "remote vault" feature[1] to collaborate on making Obsidian. Since Obsidian runs on local files you could use any shared file storage like Dropbox. If you want more granular version history, you can use Git, there's a nice plugin for it[2].
[1]: https://help.obsidian.md/Obsidian+Sync/Share+remote+vaults
[2]: https://github.com/denolehov/obsidian-git
-
Show HN: Open-source obsidian.md sync server
I've been using the main Obsidian git extension, https://github.com/denolehov/obsidian-git. Took some work to set it up ergnonomically but it works great now. I enabled auto-commit and push on save, and auto-pull when you start the editor. No merge conflicts yet between two machines.
Should note I use Obsidian for a journal, so it's pretty much append-only.
-
A Side Effect of Storing a Git Repository in iCloud Drive
I use Obsidian to create notes as Markdown files on my computer and use the Obsidian Git plugin to version control the changes via Git. The Obsidian vault in which I store my notes is stored in a folder synced using iCloud Drive.
-
Syncthing is causing battery drain. Any free alternatives?
Up to my knowledge, Obsidian GIT doesn't support merge on mobile. There is a different approach for handling those on mobile using Command Line, you can find more info in this post and this article.
-
I hate sync so much
Plugin: https://github.com/denolehov/obsidian-git
-
Seeing Edit History of a note?
I am using Git for that. Here is the extension that might help. https://github.com/denolehov/obsidian-git
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
syncthing-android - Wrapper of syncthing for Android.
MkDocs - Project documentation with Markdown.
longform - A plugin for Obsidian that helps you write and edit novels, screenplays, and other long projects.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
Trilium Notes - Build your personal knowledge base with Trilium Notes
bookdown - Authoring Books and Technical Documents with R Markdown
orgzly-android - Outliner for taking notes and managing to-do lists
obsidian-releases - Community plugins list, theme list, and releases of Obsidian.
breadcrumbs - Add structured hierarchies to your Obsidian vault
Docusaurus - Easy to maintain open source documentation websites.
obsidian-extract-pdf-highlights - Extract highlights, underlines and annotations from your PDFs into Obsidian