Skip to content

Commit 9d00e55

Browse files
committed
update readme
1 parent efee7ad commit 9d00e55

File tree

1 file changed

+24
-29
lines changed

1 file changed

+24
-29
lines changed

README.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,21 @@ _MarkDB-Connect_ can extract the BetterBibTeX citekey that specifies which Zoter
5959

6060
- In `MarkDBConnect Preferences...` (under the `Tools` menu),
6161

62-
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
62+
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
6363

64-
- The default behavior is to search for markdown files beginning with `@`.
65-
- Alternatively, you can specify a RegEx pattern to match your reading note files.
64+
- The default behavior is to search for markdown files beginning with `@`.
65+
- Alternatively, you can specify a RegEx pattern to match your reading note files.
6666

67-
- Select the `Match notes based on BetterBibTeX citekey` option.
67+
- Select the `Match notes based on BetterBibTeX citekey` option.
6868

69-
- By default, _MarkDB-Connect_ expects that the filenames of your markdown reading note files begin with `@mycitekey` but can include extra information after it (e.g. a reading note with the BetterBibTeX citekey `shepard1987science` could have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`).
69+
- By default, _MarkDB-Connect_ expects that the filenames of your markdown reading note files begin with `@mycitekey` but can include extra information after it (e.g. a reading note with the BetterBibTeX citekey `shepard1987science` could have the file name `@shepard1987science.md` or `@shepard1987science Toward a universal law of generalization for psychological science.md`).
7070

71-
- Optionally, you can have _MarkDB-Connect_ read the metadata of your markdown notes and extract the citekey from one of the fields. To enable this, specify the metadata ID (`citekey` is a common value).
71+
- Optionally, you can have _MarkDB-Connect_ read the metadata of your markdown notes and extract the citekey from one of the fields. To enable this, specify the metadata ID (`citekey` is a common value).
7272

73-
- This is necessary if the file names do not begin with the correct citekey, which may happen if the citekeys include special characters (e.g. if a citekey contains `:`, it will probably need to be taken from the yaml metadata rather than the filename).
73+
- This is necessary if the file names do not begin with the correct citekey, which may happen if the citekeys include special characters (e.g. if a citekey contains `:`, it will probably need to be taken from the yaml metadata rather than the filename).
7474

7575
- Run the synchronization function from `Tools -> MarkDBConnect Sync Tags`.
76-
- This will add a tag (`ObsCite`) to every Zotero item for which there exists a reading note in the external folder you specified.
76+
- This will add a tag (`ObsCite`) to every Zotero item for which there exists a reading note in the external folder you specified.
7777
- In the `Tags` plane of Zotero, right-click on the `ObsCite` tag and assign it a color, which will mark the tagged items in the preview plane of Zotero.
7878

7979
---
@@ -86,25 +86,25 @@ Zotero automatically generates Item Keys, they take the form of `ABCD1234`, as i
8686

8787
- In `MarkDBConnect Preferences...` (under the `Tools` menu),
8888

89-
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
89+
- Specify the location of the folder that contains your markdown reading notes (e.g. `/Users/me/Documents/ObsVault/ReadingNotes/`). The _MarkDB-Connect_ plugin will recursively search this path for markdown files.
9090

91-
- The default behavior is to search for markdown files beginning with `@`.
92-
- Alternatively, you can specify a RegEx pattern to match your reading note files.
91+
- The default behavior is to search for markdown files beginning with `@`.
92+
- Alternatively, you can specify a RegEx pattern to match your reading note files.
9393

94-
- Select the `Match notes based on Zotero-Item-Key` option.
94+
- Select the `Match notes based on Zotero-Item-Key` option.
9595

96-
- Specify a RegEx pattern to extract the Zotero-Item-Key from the markdown contents.
96+
- Specify a RegEx pattern to extract the Zotero-Item-Key from the markdown contents.
9797

98-
E.g. if your note has the line
98+
E.g. if your note has the line
9999

100-
`- local:: [local zotero](zotero://select/library/items/GZ9DQ2AM)`
100+
`- local:: [local zotero](zotero://select/library/items/GZ9DQ2AM)`
101101

102-
you could extract the Zotero key (`GZ9DQ2AM`) using this RegEx pattern:
102+
you could extract the Zotero key (`GZ9DQ2AM`) using this RegEx pattern:
103103

104-
`^- local::.+\/items\/(\w+)\)`
104+
`^- local::.+\/items\/(\w+)\)`
105105

106106
- Run the synchronization function from `Tools -> MarkDBConnect Sync Tags`.
107-
- This will add a tag (`ObsCite`) to every Zotero item for which there exists a reading note in the external folder you specified.
107+
- This will add a tag (`ObsCite`) to every Zotero item for which there exists a reading note in the external folder you specified.
108108
- In the `Tags` plane of Zotero, right-click on the `ObsCite` tag and assign it a color, which will mark the tagged items in the preview plane of Zotero.
109109

110110
---
@@ -133,22 +133,17 @@ A reference to another paper using an Obsidian wiki link: [[@cusimano2018cogsci]
133133
## Related Projects
134134

135135
- [obsidian-citation-plugin](https://github.com/hans/obsidian-citation-plugin) by hans
136-
- Obsidian plugin that integrates your Zotero database with Obsidian.
137-
136+
- Obsidian plugin that integrates your Zotero database with Obsidian.
138137
- [BibNotes Formatter](https://github.com/stefanopagliari/bibnotes) by stefanopagliari
139-
- Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
140-
138+
- Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
141139
- [Obsidian Zotero Integration](https://github.com/mgmeyers/obsidian-zotero-integration) by mgmeyers
142-
- Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
143-
140+
- Obsidian plugin to facilitate exporting annotations from Zotero into Obsidian.
144141
- [Zotero 6 'Export Notes' feature](https://forums.zotero.org/discussion/93521/available-for-beta-testing-markdown-export-of-notes/p1) by Zotero
145-
- Zotero 6 beta feature to export notes and annotations from Zotero items as markdown files.
146-
142+
- Zotero 6 beta feature to export notes and annotations from Zotero items as markdown files.
147143
- [Zotero-mdnotes](https://argentinaos.com/zotero-mdnotes/) by argenos
148-
- Zotero plugin to export metadata and notes from Zotero items as markdown files.
149-
144+
- Zotero plugin to export metadata and notes from Zotero items as markdown files.
150145
- [Zotero to Markdown](https://github.com/e-alizadeh/Zotero2md) by e-alizadeh
151-
- Python library to export annotations and notes from Zotero items as markdown files.
146+
- Python library to export annotations and notes from Zotero items as markdown files.
152147

153148

154149
## Notes

0 commit comments

Comments
 (0)