Skip to content

Commit

Permalink
doc: README and new overview image
Browse files Browse the repository at this point in the history
  • Loading branch information
nobiot committed Nov 9, 2021
1 parent 3239778 commit 2e8a92e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
[![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)

Use Org-roam with markdown files by adding Md-roam to it.
Md-roam extends the features and functions provided by [Org-roam](https://www.orgroam.com/) to support markdown files in addition to org files.
Use [Org-roam](https://www.orgroam.com/) with Markdown files by adding Md-roam
to it. Md-roam extends the features and functions provided by Org-roam to
support Markdown files. Mix Markdown with Org files in a single Org-roam database
for your Zettelkasten-style note-taking and backlinks.

![Screen shot showing main features of Org-roam supported by Md-roam](./images/2021-11-07-md-roam-overview.png)
![Screen shot showing main features of Org-roam supported by Md-roam](./images/md-roam-v2-overview.png)

1. Title and other meta data in the YAML front matter
2. Specify notes for a reference material (literature notes / bibliographic notes) with `roam_refs:`
3. #tag support to categorize notes
4. Aliases of a note with `roam_aliases:`
5. Link for backlinks with [[wiki-link]] syntax
6. Citation with Pandoc style [@citekey], @citekey -@citekey, etc.
7. Org-roam standard backlink buffer with Org mode (no modification to the database and backlink buffer)

2. `#tag` support to categorize notes

3. Specify notes as reference materials (literature notes / bibliographic notes) with `roam_refs:`

4. Aliases of a note with `roam_aliases:` in the YAML array syntax with `["alias1", "alias two" ]`

5. Link notes for backlinks with using `[[wiki-link]]` syntax and "in-line search" with `Company` or `Corfu`; the name is the **title** of a note

6. Citations with Pandoc style `[@citekey]`, `@citekey` `-@citekey`, etc. for Markdown files; for Org, Org-ref or Org-cite styles as Org-roam support them

7. Both Markdown and Org notes can cite a reference; they appear in the reflink section

8. Create backlinks between Org and Markdown files both ways; you can mix both formats in a single Org-roam database

9. Org-roam standard backlink buffer with no modification to the database schema and backlink buffer

# License

Md-Roam: Copyright © Noboru Ota

Org-Roam: Copyright © Jethro Kuan and contributors.

Distributed under the GNU General Public License, Version 3

[org]: https://orgmode.org/
Expand Down
Binary file removed images/2021-11-07-md-roam-overview.png
Binary file not shown.
Binary file added images/md-roam-v2-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2e8a92e

Please sign in to comment.