https://github.com/TheodoreChu/flashcard-editor
A flashcard editor for @StandardNotes | https://flashcardeditor.com
https://github.com/TheodoreChu/flashcard-editor
flashcards standardnotes
Last synced: about 1 month ago
JSON representation
A flashcard editor for @StandardNotes | https://flashcardeditor.com
- Host: GitHub
- URL: https://github.com/TheodoreChu/flashcard-editor
- Owner: TheodoreChu
- License: other
- Created: 2020-04-04T19:41:31.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-12T09:40:18.000Z (over 2 years ago)
- Last Synced: 2024-10-27T17:24:42.346Z (6 months ago)
- Topics: flashcards, standardnotes
- Language: JavaScript
- Homepage: https://demo.flashcardeditor.com
- Size: 9.89 MB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-standard-notes - Flashcard Editor
README
# Flashcard Editor
[](https://github.com/theodorechu/flashcard-editor/releases)
[](https://github.com/theodorechu/flashcard-editor/blob/develop/LICENSE)
[](https://github.com/theodorechu/flashcard-editor#development)
[](https://appendeditor.com/#installation)
[](https://appendeditor.com/#installation)
[](https://github.com/theodorechu/flashcard-editor/issues/)
[](https://standardnotes.org/slack)
[](https://github.com/theodorechu/flashcard-editor/releases)
[](https://github.com/theodorechu/flashcard-editor)
## Introduction
The Flashcard Editor is an **unofficial** [editor](https://standardnotes.org/help/77/what-are-editors) for [Standard Notes](https://standardnotes.org), a free, [open-source](https://standardnotes.org/knowledge/5/what-is-free-and-open-source-software), and [end-to-end encrypted](https://standardnotes.org/knowledge/2/what-is-end-to-end-encryption) notes app. It is currently in development and not ready for use. :smile:
You can find the beta demo at [demo.flashcardeditor.com](https://demo.flashcardeditor.com).
The editor supports Markdown, $\LaTeX/ \KaTeX$, emoji codes, syntax highlighting, inline HTML, table of contents, footnotes, auto-linking, and more.
## Features
- [Markdown](https://guides.github.com/features/mastering-markdown/) support provided by [Unified/Remark](https://github.com/remarkjs/remark)
- $\LaTeX/\KaTeX$ provided by hosted [KaTeX](https://github.com/KaTeX/KaTeX)
- Emojis provided by [emoji codes](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)
- Google Code and GitHub Gist flavored Syntax Highlighting provided by [highlight.js](https://github.com/highlightjs/highlight.js) stylesheets
- Table of Contents (links don't work on mobile) provided by [Remark TOC](https://github.com/remarkjs/remark-toc)
- Footnotes (links don't work on mobile) provided by [Remark footnotes](https://github.com/remarkjs/remark-footnotes)
- Notes are stored in plaintext (great for longevity)
## Installation
1. Register for an account at Standard Notes using the [Desktop App](https://standardnotes.org/download) or [Web app](https://app.standardnotes.org). Remember to use a strong and memorable password.
1. Click **Extensions** in the lower left corner.
1. Click **Import Extension**.
1. Paste this into the box:
```
https://raw.githubusercontent.com/TheodoreChu/flashcard-editor/develop/demo.ext.json
```
Alternatively, paste this link:
```
https://notes.theochu.com/p/FV2A4HJFRN
```
1. Press Enter or Return on your keyboard.
1. Click **Install**.
1. 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](https://standardnotes.org/download) after you log in.
## Development
The instructions for local setup can be found [here](https://docs.standardnotes.org/extensions/local-setup). All commands are performed in the root directory:
1. Fork the [repository](https://github.com/theodorechu/flashcard-editor) on GitHub
2. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) 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](https://docs.standardnotes.org/extensions/local-setup) with `url: "http://localhost:8002"`. Optionally, create your `ext.json` as a copy of `sample.ext.json`.
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](https://app.standardnotes.org) or [desktop](https://standardnotes.org/download) 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](https://github.com/TheodoreChu/flashcard-editor/blob/develop/LICENSE) or later.
## Further Resources
- [GitHub](https://github.com/TheodoreChu/flashcard-editor) for the source code of the Flashcard Editor
- [GitHub Issues](https://github.com/TheodoreChu/flashcard-editor/issues) for reporting issues concerning the Flashcard Editor
- [Docs](https://docs.theochu.com/flashcard-editor) for how to use the Flashcard Editor
- [Contact](https://theochu.com/contact) for how to contact the developer of the Flashcard Editor
- [Flashcard Editor To do List](https://github.com/TheodoreChu/flashcard-editor/projects/1) for the roadmap of the Flashcard Editor
- [Standard Notes Slack](https://standardnotes.org/slack) for connecting with the Standard Notes Community
- [Standard Notes Help](https://standardnotes.org/help) for help with issues related to Standard Notes but unrelated to this editor