Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benrbray/noteworthy

Markdown editor with bidirectional links and excellent math support, powered by ProseMirror. (In Development!)
https://github.com/benrbray/noteworthy

markdown markdown-editor math mathematics prosemirror text-editor

Last synced: about 8 hours ago
JSON representation

Markdown editor with bidirectional links and excellent math support, powered by ProseMirror. (In Development!)

Awesome Lists containing this project

README 

        
> Noteworthy is currently in development!  I work on Noteworthy in my free time, so progress comes in bursts.



# Noteworthy ([https://noteworthy.ink/](https://noteworthy.ink/))



A free, open-source, local-first Markdown editor built with [ProseMirror](https://prosemirror.net/).



* Works directly with your **local** files, entirely **offline**.

* Write your notes in **Markdown**, with **syntax extensions** like citations and block directives. 

* Build your own personal wiki with **bidirectional links**.

* Excellent **math** support — seamlessly transition between source and rendered math, thanks to [KaTeX](https://katex.org/) and [prosemirror-math](https://github.com/benrbray/prosemirror-math).



## Features



completed syntax features



- [x] headings, blockquotes, lists

- [x] bold, italic

- [x] inline and block code

- [x] inline and block math via [`prosemirror-math`](https://github.com/benrbray/prosemirror-math)

- [x] YAML metadata

- [x] blob-embedded images

- [x] `[[wikilink]]` syntax

- [x] citation syntax, in both `@[noteworthy]`-style and `[@pandoc]`-style

- [x] support for named environments (such as theorems, definitions, proofs) via [directive](https://github.com/remarkjs/remark-directive) syntax



completed editor features



- [x] fuzzy tag search

- [x] outline view

- [x] custom CSS with live reload

- [x] fail gracefully on unsupported markdown syntax extensions

- [x] support `\providecommand` in math nodes

- [x] code block syntax highlighting via [`codemirror`](https://codemirror.net/)

- [x] support for `tikz` diagrams via [`@drgrice1/tikzjax`](https://github.com/drgrice1/tikzjax/tree/ww-modifications) (inspired by [`obsidian-tikzjax`](https://github.com/artisticat1/obsidian-tikzjax))

- [x] autocompletion for tags and citations, via [`prosemirror-autocomplete`](https://github.com/curvenote/editor/tree/main/packages/prosemirror-autocomplete)



in development



- [ ] community plugin system

- [ ] import `bibtex` or `csl-json` bibliography file



planned



- [ ] import `bibtex` or `csl-json` bibliography file

- [ ] `flavor:` metadata for interoperability with other editors

- [ ] populate note from bibliography entry

- [ ] filesystem-local images

- (...and more!)



### Excellent Math Support



Inline Math:



![inline math](img/prosemirror-math_inline.gif)



Display Math:



![display math](img/prosemirror-math_display.gif)



### `tikz` Diagrams



Noteworthy supports [`tikz` diagrams](https://www.overleaf.com/learn/latex/TikZ_package) via [`@drgrice1/tikzjax`](https://github.com/drgrice1/tikzjax/tree/ww-modifications), which was created by compiling the original Pascal source of TeX to WebAssembly, with only the dependencies needed to run `tikz`.



![](img/noteworthy-tikzjax.gif)



## Screenshot



> (screenshot taken 12 July 2021)



![screenshot from 12 July 2021](img/noteworthy_12july2021.png)



> (screenshot taken 16 September 2020)



![screenshot from 16 September 2020](img/noteworthy_16sept2020.png)



> (screenshot taken 17 September 2020)



![screenshot from 17 September 2020](img/noteworthy_17sept2020.png)



## Feature Comparison



### Obsidian



[Obsidian](https://obsidian.md/) (especially its community plugins) has been a source of inspiration for me during the development of Noteworthy, and occupies a similar position in the note-taking space, but with a few key differences:



* Noteworthy aims to be **fully open source**, so that the editor is fully customizable beyond what is possible with community plugins alone.  By contrast, the kernel of Obsidian is closed-source, making it more difficult for empassioned users to add the features they need.

* Noteworthy is WYSIWYG-first (based on [ProseMirror](https://prosemirror.net/)), while Obsidian began as a split-pane editor and only introduced WYSIWYG-mode later (based on [CodeMirror](https://codemirror.net/)).

* Taking inspiration from [Zettlr](https://www.zettlr.com/), Noteworthy aims to provide first-class support for **bibliography** management and academic citations.

* Noteworthy aims to provide a smooth, polished experience for math-heavy and diagram-heavy notetaking.

* Noteworthy will allow the user to mix-and-match different Markdown syntax extensions per-file via `flavor` metadata, to maximize **interoperability** with other editors.



### Other Editors



The table below compares Noteworthy to other editors with similar features.  Of course, each editor has its own unique features not listed!  For an even more detailed comparison, check out the [exhaustive feature comparison](https://www.notion.so/db13644f08144495ad9877f217a161a1?v=ff6777802811416ba08dc114e0b11837) put together by the folks at [Athens Research](https://github.com/athensresearch/athens).



![feature comparison](img/noteworthy-comparison_16sept2020.png)



> Last updated 16 September 2020.  If you notice any errors or omissions in the feature comparison table, please [file an issue](https://github.com/benrbray/noteworthy/issues/new/choose) and I will correct it.



## Building Noteworthy



Noteworthy is still a bit rough around the edges, and is missing some basic quality-of-life features.  However, it's stable enough that I use it for all my daily note-taking.  You can follow these instructions if you really wish to run it.



```bash

git clone [email protected]:benrbray/noteworthy.git

cd noteworthy-electron

npm run build:linux

```



After building, look in the `/dist` folder for an executable.



## Development



Noteworthy is built with [`electron-vite`](https://evite.netlify.app/).  To run in development mode with live-reload,



```bash

cd noteworthy-electron

npm run dev

```



## Acknowledgements



* Thanks to [Marijn Haverbeke](https://marijnhaverbeke.nl/) for developing [ProseMirror](https://prosemirror.net/)!

* Thanks to [Hendrik Erz](https://github.com/nathanlesage) for keeping [Zettlr](https://github.com/Zettlr/Zettlr) open source!  When I started developing Noteworthy, I had no clue how to set up an Electron app or responsibly interact with the user's file system from Node, and the Zettlr source was a great reference.

* Thanks to Microsoft for keeping [VS Code](https://github.com/Microsoft/vscode) open source!  I learned a lot by reading the source of the VS Code tree viewer and plugin system.

* Thanks to [Fabio Spampinato](https://fabiospampinato.com/) for releasing the source to an early version [Notable](https://github.com/notable/notable)!