Code Monkey home page Code Monkey logo

zotero-better-notes's Introduction

Zotero Better Notes

teaser

Everything about note management. All in Zotero.

User Guide(EN) | 用户指引(中文)

Easy to Use

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!

Bi-directional Link Support

Bi-directional link note(双链笔记) is supported! Link your notes inside Zotero with just one click.

Export with its' linked sub-notes to Obsidian: Obsidian example

Templates

Use customized templates to import data from items/notes! template

Template Usage

Discuss & contribute your templates here

Note Enhancements

  • LaTex view

  • Heading indent

  • Image resizing(comming soon)

Quick Start Guide

Install

  • Download the latest release (.xpi file) from the Releases PageNote If you're using Firefox as your browser, right-click the .xpi and select "Save As.."
  • In Zotero click Tools in the top menu bar and then click Addons
  • Go to the Extensions page and then click the gear icon in the top right.
  • Select Install Add-on from file.
  • Browse to where you downloaded the .xpi file and select it.
  • Restart Zotero, by clicking restart now in the extensions list where the Zotero PDF Translate plugin is now listed.

Usage

All in Zotero: Best Note Practice

Review.Writing.Best.Practice.mp4

For new users, a User Guide will help you get started quickly and create a user guide note for you. Use it as a playground and explore your own workflow!

Important Changes

  • Since v0.2.0, most of the workspace bottom-left buttons are moved to menu bar.
  • Since v0.5.0, workspace will open as a Zotero tab by default. Menu -> File -> Open in New Window or press shift while clicking the Open Workspace button to use the standalone mode.

Documentation:
User Guide(EN) | 用户指引(中文)

Development & Contributing

This add-on is built on the Zotero Addon Template of zotero-pdf-translate.

Build

# A release-it command: version increase, npm run build, git push, and GitHub release
# You need to set the environment variable GITHUB_TOKEN https://github.com/settings/tokens
# release-it: https://github.com/release-it/release-it
npm run release

Alternatively, build it directly using build.js: npm run build

Build Steps

  1. Clean ./builds
  2. Copy ./addon to ./builds
  3. Esbuild to ./builds/addon/chrome/content/scripts
  4. Replace __buildVersion__ and __buildTime__ in ./builds/addon
  5. Zip the ./builds/addon to ./builds/*.xpi

Debug

  1. Copy zotero command line config file. Modify the commands.
cp zotero-cmd-default.json zotero-cmd.json
  1. Setup addon development environment following this link.

  2. Build addon and restart Zotero with this npm command.

npm run restart

You can also debug code in these ways:

Disclaimer

Use this code under AGPL (open source required). No warranties are provided. Keep the laws of your locality in mind!

Part of the code of this repo refers to other open-source projects within the allowed scope.

My Other Zotero Addons

zotero-better-notes's People

Contributors

windingwind avatar virologist avatar isharestuff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.