Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 3.02 KB

README.md

File metadata and controls

63 lines (49 loc) · 3.02 KB
Raw

Docket

locally saved markdown notes in a new tab or popup 📝

Screenshots

🌆 dark mode 🧑‍💻 code block themes 🆙 popup notes
dark mode code sample popup

Installation

Warning

Uninstalling and reinstalling the extension will erase all saved notes - please back them up before attempting to switch between the chrome store and dev extensions!

Available on the chrome web store here.

Note: The chrome web store version will likely be a few versions behind. If you're looking to keep up to date with the latest version of docket, I recommend cloning this repo and simply using it as an extension in dev mode :D

  1. Clone or download this repo and unzip (if you downloaded a zip file).
  2. Go to chrome://extensions/ or wherever you manage extensions.
  3. Enable developer mode and click load unpacked.
  4. Select the (unzipped) root folder.

Done!

Build

  1. npm install
  2. npm run build

Dependencies

Layout

  • manifest holds extension metadata
  • icons holds extension icon
  • src holds typescript source code
  • dist holds all html, css, compiled js, and bundled modules (using rspack)

Todo

There's a lot of improvements and features I'd like to add, and feature requests are always welcome.

Here's a few things that I have in mind:

  • Editor Features
    • Keyboard shortcuts for common markdown actions (bold, italic, etc.)
    • Import/export markdown files
      • This might not be possible due to restrictions on file access in chrome extensions
      • Also, just paste the markdown into the editor, dummy 🥱
  • Autosave
    • Query chrome storage when a user refocuses the tab or extension to prevent overwriting changes when multiple instances of docket are open
  • Settings
    • Change the font size
    • Change the font family
    • Change parser options (like enabling/disabling GFM)
  • Optimizations/QoL
    • Lazy render markdown (only rerender when the markdown changes)
      • This is a bit tricky because I would need a way to sourcemap the markdown to the rendered html, which is nontrivial.
    • Scroll sync between the markdown and the rendered html
      • Again, this probably requires sourcemapping the markdown to the rendered html.
    • Extend/rewrite some of the parsing rules to tag the html elements with classes for easier styling
      • This would allow for more advanced styling options and also remove the need for the hacky css overrides I have in place for things like inline code blocks.