update: readme
This commit is contained in:
xiangyu
parent
640d392d9d
commit
ed3bb8b488
88
README.md
88
README.md
|
|
@ -6,7 +6,34 @@ Everything about note management. All in Zotero.
|
|||
|
||||
Better Notes Handbook: [EN](https://github.com/windingwind/zotero-better-notes/wiki) | [中文 (provide translation)](https://zotero.yuque.com/staff-gkhviy/better-notes/biigg4?)
|
||||
|
||||
User Guide(lacks maintenance|缺少维护): [EN](./UserGuide.md) | [中文](./UserGuideCN.md)
|
||||
User Guide: [EN](./UserGuide.md) | [中文](./UserGuideCN.md)
|
||||
|
||||
## Introduction
|
||||
|
||||
Better Notes is a plugin for [Zotero](https://zotero.org).
|
||||
|
||||
It streamlines your unordered workflows of metadata analyzing, paper reading, annotating, and note-taking into a closed loop in Zotero.
|
||||
|
||||
Works out of the box and is highly customizable.
|
||||
|
||||
## Contents
|
||||
|
||||
- [Quick start](#quick-start)
|
||||
- [Install](#install)
|
||||
- [Note workspace](#note-workspace)
|
||||
- Connect notes with the [bi-directional links](#bi-directional-link-support)
|
||||
- Automate note generation with the [note templates](#note-templates)
|
||||
- [Export notes](#export) to different formats
|
||||
- Integrate with 3rd-party MarkDown editors seamlessly with [note<->markdown syncing](#syncing-note-markdown)
|
||||
- [Other features](#other-features)
|
||||
|
||||
## Quick Start
|
||||
|
||||
> See [Handbook:Quick Start](https://zotero.yuque.com/staff-gkhviy/better-notes/gw5d7v) for more details.
|
||||
|
||||
New to note-taking? Install and start now!
|
||||
|
||||
Already an Obsidian/Logseq/... user? Forget those complicated integration tools and keep them in sync with MarkDown files with just one click.
|
||||
|
||||
## Install
|
||||
|
||||
|
|
@ -17,16 +44,6 @@ User Guide(lacks maintenance|缺少维护): [EN](./UserGuide.md) | [中文](./Us
|
|||
- Browse to where you downloaded the `.xpi` file and select it.
|
||||
- Restart Zotero, by clicking `restart now` in the extensions list where the plugin is now listed.
|
||||
|
||||
## Easy to Use
|
||||
|
||||
> See [Handbook:Quick Start](https://zotero.yuque.com/staff-gkhviy/better-notes/gw5d7v) for more details.
|
||||
|
||||
New to note-taking? Install and start now!
|
||||
|
||||
Already an Obsidian/Logseq/... user? Archive annotations with double chain and export with just one click!
|
||||
|
||||
It works out of the box. No complicated and annoying configuration!
|
||||
|
||||
## Note Workspace
|
||||
|
||||
> See [Handbook:Workspace](https://zotero.yuque.com/staff-gkhviy/better-notes/yul2qm) for more details.
|
||||
|
|
@ -36,7 +53,7 @@ The workspace allows you to focus on the note, as shown in the teaser on top of
|
|||
- Note outline(tree view, mindmap, and bubble map)
|
||||
- Note links Preview
|
||||
|
||||
## Bi-directional Link Support
|
||||
## Bi-directional Link
|
||||
|
||||
> See [Handbook:Bi-directional Link](https://zotero.yuque.com/staff-gkhviy/better-notes/yxpiew) for more details.
|
||||
|
||||
|
|
@ -52,9 +69,11 @@ Export with its' linked sub-notes to Obsidian:
|
|||
Use customized templates to import data from items/notes!
|
||||
|
||||
|
||||
[Learn more about template](./Template.md)
|
||||
[How to Use Templates](./TemplateUsage.md)
|
||||
|
||||
See what templates can do and find templates contributed by the community here: [Note Templates from Community](https://github.com/windingwind/zotero-better-notes/issues/85)
|
||||
[How to Write Your Own Template](./TemplateDoc)
|
||||
|
||||
See what templates can do and find templates contributed by the community here: [Note Templates from Community](https://github.com/windingwind/zotero-better-notes/discussions/categories/note-templates)
|
||||
|
||||
## Export
|
||||
|
||||
|
|
@ -66,33 +85,36 @@ See what templates can do and find templates contributed by the community here:
|
|||
- To PDF document(.pdf)
|
||||
- To FreeMind file(.mm)
|
||||
|
||||
## Syncing: Note->MarkDown
|
||||
## Syncing: Note<->MarkDown
|
||||
|
||||
> See [Handbook:Sycn](https://zotero.yuque.com/staff-gkhviy/better-notes/aid2c3) for more details.
|
||||
|
||||
> We are planning to have a two-path syncing for note<->MarkDown. Discuss here: https://github.com/windingwind/zotero-better-notes/issues/147
|
||||
It's painless to Better Notes into your current workflow if you are using software like Obsidian. Keep your notes in sync with external MD files with one click.
|
||||
|
||||
Keeping the MarkDown version of your notes in sync with the latest changes inside Zotero is extremely easy now.
|
||||
Click 'Auto Sync to Export Path' the first time you export your note. Do not require any third-party tools or complicated setups!
|
||||
|
||||
Just click 'Auto Sync to Export Path' the first time you export your note. Do not require any third-party tools!
|
||||
Any modification in the note or its corresponding MarkDown file will be automatically synced.
|
||||
|
||||
|
||||
|
||||
|
||||
## Other Features
|
||||
|
||||
> See [Handbook:Other Features](https://zotero.yuque.com/staff-gkhviy/better-notes/sh4v2y) for more details.
|
||||
|
||||
- Annotation2Note
|
||||
<img src="./image/README/markdowncomment.png" width="400px"></img>
|
||||
Create a note from annotation by just on click. `markdown` is supported!
|
||||
|
||||
- Heading mark
|
||||
<img src="./image/README/headingmark.png" width="400px"></img>
|
||||
|
||||
- Cite Items(`"` button)
|
||||
|
||||
- Image resizing(right click on images)
|
||||
|
||||
- Quick Note: annotation to note with one click. Support MarkDown comments.
|
||||
<img src="./image/README/markdowncomment.png" width="400px"></img>
|
||||
- Auto-insert new annotations to note. Disabled by default.
|
||||
- Format MarkDown/AsciiDoc in the clipboard.
|
||||
- Quick Cite: cite items in the note with the given cite format.
|
||||
- Image annotation math OCR.
|
||||
- Resize images (right-click on images).
|
||||
- Preview images (double-click/ctrl-click on images).
|
||||
- Customize link actions.
|
||||
- Note editor enhancements.
|
||||
- Quick switch main note.
|
||||
- Copy note link.
|
||||
- Import from MarkDown.
|
||||
- Quick Cite.
|
||||
- ...
|
||||
|
||||
## Development & Contributing
|
||||
|
|
@ -112,15 +134,15 @@ Alternatively, build it directly using build.js: `npm run build`
|
|||
|
||||
### Debug
|
||||
|
||||
1. Copy zotero command line config file. Modify the commands.
|
||||
1. Copy the Zotero command line config file. Modify the commands.
|
||||
|
||||
```sh
|
||||
cp zotero-cmd-default.json zotero-cmd.json
|
||||
```
|
||||
|
||||
2. Setup addon development environment following this [link](https://www.zotero.org/support/dev/client_coding/plugin_development#setting_up_a_plugin_development_environment).
|
||||
2. Initialize the addon development environment following this [link](https://www.zotero.org/support/dev/client_coding/plugin_development#setting_up_a_plugin_development_environment).
|
||||
|
||||
3. Build addon and restart Zotero with this npm command.
|
||||
3. Build the addon and restart Zotero with this npm command.
|
||||
|
||||
```sh
|
||||
npm run restart
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB |
Loading…
Reference in New Issue