generated from srid/rib-sample
-
-
Notifications
You must be signed in to change notification settings - Fork 150
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
164 additions
and
145 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# Zettel Markdown | ||
|
||
Zettel files are written using Markdown[^other], per the [CommonMark](https://commonmark.org/) specification. Neuron uses [commonmark-hs](https://github.com/jgm/commonmark-hs) to parse them into the [Pandoc AST](https://pandoc.org/using-the-pandoc-api.html), as well as provides an extention on top to handle zettel links. | ||
Zettel files are written in Markdown[^other], per the [CommonMark](https://commonmark.org/) specification. Neuron uses [commonmark-hs](https://github.com/jgm/commonmark-hs) to parse them into the [Pandoc AST](https://pandoc.org/using-the-pandoc-api.html), as well as provides an extention on top to handle zettel links. | ||
|
||
* <2011504> | ||
* <2011505> | ||
* <2013702> | ||
* <2013701> | ||
* <2016401> | ||
* [[[2011504]]] | ||
* [[[2011505]]] | ||
* [[[2013702]]] | ||
* [[[2013701]]] | ||
* [[[2016401]]] | ||
* Styling elements using Semantic UI ([#176](https://github.com/srid/neuron/issues/176)) | ||
|
||
[^other]: Neuron is designed to be extended with other markup formats as well. Org-mode is currently supported (see the `formats` setting in <2011701?cf>) but is [experimental](https://github.com/srid/neuron/issues/275). Neuron recommends Markdown, which is supported everywhere including <041726b3?cf>. | ||
[^other]: Neuron is designed to be extended with other markup formats as well. Org-mode is currently supported (see the `formats` setting in [[2011701]]) but is [experimental](https://github.com/srid/neuron/issues/275). Neuron recommends Markdown, which is supported everywhere including [[041726b3]]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# Graph view | ||
|
||
A zettelkasten is a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). Neuron also has the notion of <2017401>, which is a subset of this graph established by having zettels "branch off" to other zettels. | ||
A zettelkasten is a [directed graph](https://en.wikipedia.org/wiki/Directed_graph). Neuron also has the notion of [[[2017401]]], which is a subset of this graph established by having zettels "branch off" to other zettels. | ||
|
||
## z-index | ||
|
||
The z-index page (at `/z-index.html`; also linked in the header) displays the zettelkasten <2017401> for all <2012301> in the zettelkasten graph. | ||
The z-index page (at `/z-index.html`; also linked in the header) displays the zettelkasten [[[2017401]]] for all [[[2012301]]] in the zettelkasten graph. | ||
|
||
## Uplinks and Backlinks | ||
|
||
A backlink of a zettel is a zettel that links to it. If that link is a folgezettel link, it is called an "uplink". Each zettel has its <5e41fd32?cf> displayed at the top. | ||
A backlink of a zettel is a zettel that links to it. If that link is a folgezettel link, it is called an "uplink". Each zettel has its [[5e41fd32]] displayed at the top. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,43 @@ | ||
# Linking | ||
|
||
To link to another zettel, put the <2011403?cf> inside angle brackets[^wikistyle]: | ||
To link to another zettel, put the [[2011403]] inside `[[[..]]]` or `[[..]]`[^autolink]: | ||
|
||
```markdown | ||
This is a zettel file, which links to another zettel: | ||
``` | ||
This is a zettel file, which links (branches of) to another zettel: | ||
* <ef3dke98> | ||
* [[[ef3dke98]]] | ||
``` | ||
|
||
Such a link instructs neuron to automatically create a connection between the | ||
associated zettels, which ultimately affects the <2017401?cf> of your zettel | ||
graph. In <2011405?cf>, neuron will automatically display the title of the | ||
linked zettel. | ||
The 3-bracket syntax creates a special link (called a folgezettel) to the | ||
specified zettel. When a zettel has a folgezettel relationship to another | ||
zettel, it is said to "branch of" to the other zettel. Folgezetel relationships | ||
define the [[2017401]] of your zettel graph. | ||
|
||
In [[2011405]], neuron will automatically display the title of the | ||
linked zettel. | ||
|
||
## Non-branching links | ||
|
||
If your link is merely a reference to another zettel, and you do not wish it to | ||
be part of the <2017401?cf> and the linked zettel's <5e41fd32?cf>, use the | ||
`cf`[^cf] query flag (eg: `<ef3dke98?cf>`). | ||
be part of the [[2017401]] and the linked zettel's [[5e41fd32]], use the | ||
2-bracket syntax: (eg: `[[ef3dke98]]`). | ||
|
||
```markdown | ||
``` | ||
This is a zettel file, which refers to another zettel without | ||
strongly linking to it: | ||
branching to it: | ||
* <ef3dke98?cf> | ||
* [[ef3dke98]] | ||
``` | ||
|
||
Neuron will link the zettels, but the link would be ignored from <2017401?cf> | ||
as well as the <5e41fd32?cf> of zettel with ID "ef3dke98". | ||
Neuron will link the zettels, but the link would be ignored from [[2017401]] | ||
as well as the [[5e41fd32]] of the zettel. | ||
|
||
## Advanced linking | ||
|
||
* <2011506> | ||
|
||
[^cf]: | ||
> The abbreviation cf. (short for the Latin: *confer/conferatur*, both meaning "compare") is used in writing to refer the reader to other material to make a comparison with the topic being discussed. [Wikipedia](https://en.wikipedia.org/wiki/Cf.) | ||
[^wikistyle]: | ||
Neuron additionally supports "wiki-style" linking. `[[ef3dke98]]` is the | ||
same as `<ef3dke98>`. | ||
|
||
NOTE: This is an **experimental** feature; it will be changed when | ||
the [Flexible links](https://github.com/srid/neuron/issues/312) proposal | ||
gets implemented. | ||
|
||
Wiki-style linking was added to allow users to edit their neuron | ||
notes in existing Zettelkasten software like Zettlr. Note that those software | ||
may not recognize the full range of Neuron links. See | ||
[#229](https://github.com/srid/neuron/issues/229#issuecomment-645756080) for | ||
details. | ||
* [[[2011506]]] | ||
|
||
[^autolink]: | ||
Neuron used to use "autolink" style linking. `<ef3dke98>` is the | ||
same as `[[[ef3dke98]]]`; and `<ef3dke98?cf>` is the same as | ||
`[[ef3dke98]]`. Autolinks are supported for backwards compatibility only; | ||
users are recommended to use the new wiki-style links. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Clusters | ||
|
||
Your Zettelkasten may have two or more clusters, not [connected](https://en.wikipedia.org/wiki/Connected_graph) to one another. The z-index will display these clusters, with each cluster's <2017401?cf> rendered as a [forest](https://tinyurl.com/wikipedia-forest), whose roots (aka "[mother](https://www.geeksforgeeks.org/find-a-mother-vertex-in-a-graph/) zettels") could be considered as a portal zettel into that sub-Zettelkasten. | ||
Your Zettelkasten may have two or more clusters, not [connected](https://en.wikipedia.org/wiki/Connected_graph) to one another. The z-index will display these clusters, with each cluster's [[2017401]] rendered as a [forest](https://tinyurl.com/wikipedia-forest), whose roots (aka "[mother](https://www.geeksforgeeks.org/find-a-mother-vertex-in-a-graph/) zettels") could be considered as a portal zettel into that sub-Zettelkasten. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.