mirror of
https://github.com/org-roam/org-roam
synced 2025-08-01 12:17:21 -05:00
(docs): Add link to slack invite (#242)
This commit is contained in:
30
README.md
30
README.md
@ -4,26 +4,24 @@
|
|||||||
|
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
Org-roam is a rudimentary [Roam][roamresearch] replica built around
|
Org-roam is a [Roam][roamresearch] replica built on top of the
|
||||||
the all-powerful [Org-mode][org].
|
all-powerful [Org-mode][org].
|
||||||
|
|
||||||
Like Roam, Org-roam offers a powerful and effortless non-hierarchical
|
Org-roam is a solution for effortless non-hierarchical note-taking
|
||||||
note-taking approach. With Org-roam, notes flow naturally, making
|
with Org-mode. With Org-roam, notes flow naturally, making note-taking
|
||||||
note-taking fun and easy. Org-roam *enables* a note-taking workflow that
|
fun and easy. Org-roam should also work as a plug-and-play solution
|
||||||
is not fluid with vanilla Org-mode (more in [this blog
|
for anyone already using Org-mode for their personal wiki.
|
||||||
post](https://blog.jethro.dev/posts/how_to_take_smart_notes_org/)).
|
|
||||||
|
|
||||||
|
Org-roam aims to implement the core features of Roam, leveraging the
|
||||||
The goal of the project is to implement core features of Roam around
|
mature ecosystem around Org-mode where possible. Eventually, we hope
|
||||||
Org-mode, and eventually introduce features enabled by the Emacs
|
to further introduce features enabled by the Emacs ecosystem.
|
||||||
ecosystem.
|
|
||||||
|
|
||||||
Visit [the documentation
|
|
||||||
page](https://org-roam.readthedocs.io/en/latest/) for a tutorial and
|
|
||||||
more links.
|
|
||||||
|
|
||||||
As of February 2020, it is in a very early stage of development.
|
As of February 2020, it is in a very early stage of development.
|
||||||
|
|
||||||
|
Important links:
|
||||||
|
|
||||||
|
- **[Documentation][docs]**
|
||||||
|
- **[Org-roam Slack][slack]**
|
||||||
## A Preview
|
## A Preview
|
||||||
|
|
||||||
Here's a screenshot of `org-roam`. The `org-roam` buffer shows
|
Here's a screenshot of `org-roam`. The `org-roam` buffer shows
|
||||||
@ -80,3 +78,5 @@ General Public License, Version 3
|
|||||||
[roamresearch]: https://www.roamresearch.com/
|
[roamresearch]: https://www.roamresearch.com/
|
||||||
[org]: https://orgmode.org/
|
[org]: https://orgmode.org/
|
||||||
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
|
[badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
|
||||||
|
[docs]: https://org-roam.readthedocs.io/
|
||||||
|
[slack]: https://join.slack.com/t/orgroam/shared_invite/zt-clh0g0tx-j8xg1kVxnrWdKt16gmSGPQ
|
||||||
|
@ -5,11 +5,10 @@
|
|||||||
Org-roam is a [Roam][roamresearch] replica built around the
|
Org-roam is a [Roam][roamresearch] replica built around the
|
||||||
all-powerful [Org-mode][org].
|
all-powerful [Org-mode][org].
|
||||||
|
|
||||||
Org-roam is a solution for effortless non-hierarchical note-taking,
|
Org-roam is a solution for effortless non-hierarchical note-taking
|
||||||
building upon Org-mode. This solution is heavily inspired by [Roam
|
with Org-mode. With Org-roam, notes flow naturally, making note-taking
|
||||||
Research][roamresearch]. With Org-roam, notes flow naturally, making
|
fun and easy. Org-roam should also work as a plug-and-play solution
|
||||||
note-taking fun and easy. Org-roam should also work as a plug-and-play
|
for anyone already using Org-mode for their personal wiki.
|
||||||
solution for anyone already using Org-mode for their personal wiki.
|
|
||||||
|
|
||||||
To understand more about Roam, a collection of links are available in
|
To understand more about Roam, a collection of links are available in
|
||||||
[the appendix](notetaking_workflow.md).
|
[the appendix](notetaking_workflow.md).
|
||||||
|
@ -3,6 +3,10 @@ repo_url: https://github.com/jethrokuan/org-roam/
|
|||||||
edit_uri: edit/master/doc/
|
edit_uri: edit/master/doc/
|
||||||
copyright: "Copyright (C) 2020 Jethro Kuan and contributors"
|
copyright: "Copyright (C) 2020 Jethro Kuan and contributors"
|
||||||
docs_dir: doc
|
docs_dir: doc
|
||||||
|
extra:
|
||||||
|
social:
|
||||||
|
- type: 'slack'
|
||||||
|
link: 'https://join.slack.com/t/orgroam/shared_invite/zt-clh0g0tx-j8xg1kVxnrWdKt16gmSGPQ'
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- A Tour of Org-roam: tour.md
|
- A Tour of Org-roam: tour.md
|
||||||
|
Reference in New Issue
Block a user