Coder Social home page Coder Social logo

jeannela2019 / noteworthy Goto Github PK

View Code? Open in Web Editor NEW

This project forked from benrbray/noteworthy

0.0 0.0 0.0 6.21 MB

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

Home Page: https://noteworthy.ink

License: GNU Affero General Public License v3.0

TypeScript 82.68% HTML 0.07% JavaScript 4.59% CSS 12.66%

noteworthy's Introduction

Noteworthy is currently in development! I work on Noteworthy in my free time, so progress comes in bursts. I hope to have a public beta available for release before January 2022.

A free, open-source, local-first Markdown editor built with ProseMirror.

  • 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 and prosemirror-math.

Excellent Math Support

Inline Math:

inline math

Display Math:

display math

Screenshot

(screenshot taken 12 July 2021)

screenshot from 12 July 2021

(screenshot taken 16 September 2020)

screenshot from 16 September 2020

(screenshot taken 17 September 2020)

screenshot from 17 September 2020

Feature Comparison

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 put together by the folks at Athens Research.

feature comparison

If you notice an error in the feature comparison table, please file an issue and I will correct it.

Building Noteworthy

Noteworthy is NOT quite ready for use. However, you can follow these instructions if you really wish to run it.

git clone --recurse-submodules [email protected]:benrbray/noteworthy.git
cd noteworthy
npm install
npm run dist

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

Acknowledgements

  • Thanks to Marijn Haverbeke for developing ProseMirror!
  • Thanks to Hendrik Erz for keeping 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 open source! I learned a lot by reading the source of the VS Code tree viewer and plugin system.
  • Thanks to Fabio Spampinato for releasing the source to an early version Notable!

noteworthy's People

Contributors

benrbray 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.