Top Related Projects
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
A personal knowledge management and sharing system for VSCode
The personal knowledge management (PKM) tool that grows as you do!
A plain text note-taking assistant
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
Quick Overview
The obsidianmd/obsidian-releases repository is the official release channel for Obsidian, a powerful knowledge base application that works on top of local folders of plain text Markdown files. This repository contains release notes, plugin API documentation, and serves as a central hub for Obsidian's development and community contributions.
Pros
- Centralized location for Obsidian releases and documentation
- Transparent development process with detailed release notes
- Active community engagement and contribution
- Comprehensive plugin API documentation for developers
Cons
- Limited to release information and API docs, not the full Obsidian source code
- May require frequent checking for updates
- Could be overwhelming for non-technical users
- Lacks a built-in issue tracker for bug reports or feature requests
Getting Started
As this is not a code library but rather a repository for release information and documentation, there's no code-specific getting started guide. However, users and developers can benefit from this repository by:
- Checking the latest release notes in the
releases.json
file - Reviewing the plugin API documentation in the
plugin-docs
folder - Following the repository to stay updated on new Obsidian releases
- Contributing to the documentation or reporting issues through the appropriate channels mentioned in the repository
Competitor Comparisons
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Pros of Logseq
- Open-source and fully free, encouraging community contributions
- Built-in graph view for visualizing connections between notes
- Supports both Markdown and Org-mode syntax
Cons of Logseq
- Steeper learning curve due to its outliner-based structure
- Less extensive plugin ecosystem compared to Obsidian
- Limited customization options for the user interface
Code Comparison
Logseq (ClojureScript):
(defn get-block-content
[block]
(when (map? block)
(:content block)))
Obsidian (TypeScript):
export function getBlockContent(block: TFile): string | null {
if (block instanceof TFile) {
return block.content;
}
return null;
}
Both projects use different programming languages, reflecting their distinct architectures. Logseq is built with ClojureScript, emphasizing functional programming, while Obsidian uses TypeScript, providing strong typing for JavaScript. The code snippets demonstrate basic operations for retrieving block content, showcasing the syntactical differences between the two languages.
A personal knowledge management and sharing system for VSCode
Pros of Foam
- Open-source and fully customizable
- Integrated with Visual Studio Code for a familiar development environment
- Supports multiple knowledge graph visualization options
Cons of Foam
- Less polished user interface compared to Obsidian
- Smaller community and plugin ecosystem
- Steeper learning curve for non-developers
Code Comparison
Foam (JavaScript):
const graph = new Graph();
graph.addNode('concept1');
graph.addNode('concept2');
graph.addEdge('concept1', 'concept2');
Obsidian (JavaScript):
app.workspace.activeLeaf.openFile(app.metadataCache.getFirstLinkpathDest('concept1', ''));
app.workspace.activeLeaf.openFile(app.metadataCache.getFirstLinkpathDest('concept2', ''));
Both projects use JavaScript, but Foam's code is more focused on graph manipulation, while Obsidian's API is geared towards file operations and workspace management. Foam's approach allows for more flexibility in creating custom knowledge structures, while Obsidian provides a more streamlined experience for typical note-taking workflows.
The personal knowledge management (PKM) tool that grows as you do!
Pros of Dendron
- Open-source and highly extensible, allowing for community contributions and customizations
- Hierarchical note-taking system with powerful refactoring and navigation features
- Built-in version control and publishing capabilities
Cons of Dendron
- Steeper learning curve due to its hierarchical structure and advanced features
- Requires VS Code as the primary editor, which may not appeal to all users
- Smaller community and ecosystem compared to Obsidian
Code Comparison
Dendron (schema.yml):
version: 1
schemas:
- id: root
children:
- projects
- areas
- resources
Obsidian (no equivalent file, uses folder structure):
.
├── Projects/
├── Areas/
└── Resources/
Summary
Dendron offers a more structured and hierarchical approach to note-taking, with built-in version control and publishing features. It's highly extensible but requires VS Code and has a steeper learning curve. Obsidian, on the other hand, provides a more flexible and user-friendly experience with a larger community and plugin ecosystem. The choice between the two depends on personal preferences and specific note-taking needs.
A plain text note-taking assistant
Pros of zk
- Command-line interface for efficient note-taking and management
- Lightweight and fast, suitable for users who prefer terminal-based workflows
- Flexible and customizable with support for various text editors
Cons of zk
- Steeper learning curve for users not familiar with command-line tools
- Less visual and interactive compared to graphical note-taking applications
- Smaller community and ecosystem of plugins/extensions
Code Comparison
zk:
zk new "My new note"
zk list --tag important
zk edit <note-id>
Obsidian:
// No direct code comparison available
// Obsidian uses a graphical interface
// and plugin system for functionality
Summary
zk is a command-line tool for note management, offering speed and flexibility for terminal-savvy users. Obsidian, on the other hand, provides a graphical interface with a rich ecosystem of plugins and visual features. While zk excels in efficiency and customization through text-based workflows, Obsidian offers a more user-friendly experience with visual linking and graphing capabilities. The choice between the two depends on personal preferences for command-line vs. graphical interfaces and the desired level of visual representation for notes and connections.
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Pros of SiYuan
- Built-in sync and backup functionality
- Supports block-level references and bidirectional links
- Offers a web-based interface for easy access across devices
Cons of SiYuan
- Less extensive plugin ecosystem compared to Obsidian
- Steeper learning curve for some users
- Limited customization options for themes and appearance
Code Comparison
SiYuan (SQL-like query language):
SELECT * FROM blocks WHERE content LIKE '%example%'
Obsidian (JavaScript-based search):
app.workspace.getActiveFile().content.contains('example')
Summary
SiYuan and Obsidian are both powerful note-taking applications with distinct features. SiYuan offers built-in sync and a web-based interface, making it convenient for cross-device usage. It also provides block-level references and bidirectional links, enhancing note organization.
However, SiYuan has a smaller plugin ecosystem and may have a steeper learning curve for some users. It also offers fewer customization options compared to Obsidian.
Obsidian, on the other hand, boasts a large and active community, resulting in an extensive plugin ecosystem and more customization possibilities. It uses a simpler Markdown format, which may be more familiar to some users.
The code comparison shows that SiYuan uses an SQL-like query language for searching, while Obsidian relies on JavaScript-based methods. This difference reflects the underlying architecture and approach of each application.
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
Pros of Athens
- Open-source and self-hostable, allowing for greater customization and control
- Built with Clojure, offering potential performance benefits for complex operations
- Focuses on networked thought and knowledge graphs, enhancing interconnected note-taking
Cons of Athens
- Smaller community and ecosystem compared to Obsidian
- Less mature and fewer features than Obsidian, which has been in development longer
- Steeper learning curve due to its unique approach and less documentation
Code Comparison
Athens (ClojureScript):
(defn create-page [title]
(let [new-page {:title title :content ""}]
(db/transact! [new-page])))
Obsidian (JavaScript/TypeScript):
app.vault.create(title + ".md", "").then((file) => {
app.workspace.activeLeaf.openFile(file);
});
Both examples demonstrate creating a new page/note, but Athens uses a database transaction approach, while Obsidian interacts directly with the file system.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
About this repo
This repo is used for hosting public releases of Obsidian, as well as our community plugins & themes directories.
Obsidian is not open source software and this repo DOES NOT contain the source code of Obsidian. However, if you wish to contribute to Obsidian, you can easily do so with our extensive plugin system. A plugin guide can be found here: https://docs.obsidian.md
This repo does not accept issues, if you have questions or issues with plugins, please go to their own repo to file them. If you have questions or issues about core Obsidian itself, please post them to our community: https://obsidian.md/community
Submit your plugin or theme
When opening a pull request, please switch to preview mode and select the option to go through our submission checklist. Submit your entry by following the convention in the JSON file and we will review your submission.
Thanks for submitting your creations!
You can find a detailed explanation for submitting your plugin here and your theme here.
Policies
All submissions must conform with our developer policies
Community Theme
To add your theme to our theme store, make a pull request to the community-css-theme.json
file. Please add your theme to the end of the list.
name
: a unique name for your theme. Must not collide with other themes.author
: the author's name for display.repo
: the GitHub repository identifier, in the form ofuser-name/repo-name
, if your GitHub repo is located athttps://github.com/user-name/repo-name
.screenshot
: path to the screenshot of your theme.modes
: if your theme supports both dark and light mode, put["dark", "light"]
. Otherwise, put["dark"]
if your theme only supports dark mode, or["light"]
if your theme only supports light mode.publish
: if your theme supports Obsidian Publish, set this totrue
. Omit it otherwise.
To get your theme compatible with Obsidian Publish, you can use applyCss
and applyCssByLink
to test out your CSS in the developer console of Obsidian Publish sites, so that you don't actually need to own sites to test your publish.css
. You can test it out on our help site here: https://help.obsidian.md/
applyCss
takes a CSS string, you can use backtick (template strings) for multiline CSS. applyCssByLink
takes a link and loads the CSS, would recommend GitHub raw file URLs.
Community Plugin
Community Plugins format
To add your plugin to the list, make a pull request to the community-plugins.json
file. Please add your plugin to the end of the list.
id
: A unique ID for your plugin. Make sure this is the same one you have in yourmanifest.json
.name
: The name of your plugin.author
: The author's name.description
: A short description of what your plugin does.repo
: The GitHub repository identifier, in the form ofuser-name/repo-name
, if your GitHub repo is located athttps://github.com/user-name/repo-name
.
How community plugins are pulled
- Obsidian will read the list of plugins in
community-plugins.json
. - The
name
,author
anddescription
fields are used for searching. - When the user opens the detail page of your plugin, Obsidian will pull the
manifest.json
andREADME.md
from your GitHub repo). - The
manifest.json
in your repo will only be used to figure out the latest version. Actual files are fetched from your GitHub releases. - If your
manifest.json
requires a version of Obsidian that's higher than the running app, yourversions.json
will be consulted to find the latest version of your plugin that is compatible. - When the user chooses to install your plugin, Obsidian will look for your GitHub releases tagged identically to the version inside
manifest.json
. - Obsidian will download
manifest.json
,main.js
, andstyles.css
(if available), and store them in the proper location inside the vault.
Announcing the First Public Release of your Plugin/Theme
- Once admitted to the plugin/theme browser, you can announce the public availability of your plugin/theme:
- in the forums as a showcase, and
- on the Discord Server in the channel
#updates
. (You need thedeveloper
role to be able to post in that channel; you can get that role here.)
- You can also announce the first working version of your plugin as a public beta before "officially" submitting it to the plugin/theme browser. That way, you can acquire some beta testers for feedback. It's recommended to use the BRAT Plugin to make the installation as easy as possible for interested beta testers.
Top Related Projects
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
A personal knowledge management and sharing system for VSCode
The personal knowledge management (PKM) tool that grows as you do!
A plain text note-taking assistant
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot