Flashcard Editor

License Maintenance Not ready for use GitHub issues Slack

Introduction

The Flashcard Editor is an unofficial Custom Editor for Standard Notes, a free, open-source, and end-to-end encrypted notes app.It is currently in development and not ready for use. ๐Ÿ˜„

You can find the beta demo at beta.flashcardeditor.com.

The editor supports Markdown, LaTeX/KaTeX\LaTeX/ \KaTeX, emoji codes, syntax highlighting, inline HTML, table of contents, footnotes, auto-linking, and more.

Features

  • Markdown support provided by Unified/Remark
  • LaTeX/KaTeX\LaTeX/\KaTeX provided by hosted KaTeX
  • Emojis provided by emoji codes
  • Google Code and GitHub Gist flavored Syntax Highlighting provided by highlight.js stylesheets
  • Table of Contents (links don't work on mobile) provided by Remark TOC
  • Footnotes (links don't work on mobile) provided by Remark footnotes
  • Notes are stored in plaintext (great for longevity)

Installation

  1. Register for an account at Standard Notes using the Desktop App or Web app. Remember to use a strong and memorable password.
  2. Click Extensions in the lower left corner.
  3. Click Import Extension.
  4. Paste this into the box:
    https://notes.theochu.com/p/FV2A4HJFRN
  5. Press Enter or Return on your keyboard.
  6. Click Install.
  7. At the top of your note, click Editor, then click Flashcard Editor - Beta.

After you have installed the editor on the web or desktop app, it will automatically sync to your mobile app after you log in.

Development

The instructions for local setup can be found here. All commands are performed in the root directory:

  1. Fork the repository on GitHub
  2. Clone your fork of the repository
  3. Type cd flashcard-editor
  4. Run npm install to locally install the packages in package.json
  5. Create ext.json as shown here with url: "http://localhost:8002/dist/index.html". Optionally, create your ext.json as a copy of ext.json.sample.
  6. Install http-server using sudo npm install -g http-server
  7. Start the server at http://localhost:8002 using npm run server
  8. Import the extension into the web or desktop app with http://localhost:8002/ext.json.
  9. To build the editor, open another command window and run npm run build. For live builds, use npm run watch. You can also run npm run start and open the editor at http://localhost:8080.

License

Copyright (c) Theodore Chu. All Rights Reserved. Licensed under AGPL-3.0 or later.

Further Resources

Last updated on