Append Editor - a free markdown editor for Standard Notes

Append Editor

Release License Status Cost GitHub issues Slack Downloads GitHub Stars

Introduction

The Append Editor is an unofficial editor for Standard Notes, a free, open-source, and end-to-end encrypted notes app.

You can find the beta demo at beta.appendeditor.com the alpha demo at alpha.appendeditor.com.

The Append Editor follows the "read first" philosophy. When you open your notes, the editor starts in 'read/view only' mode so you can't accidentally accidentally edit old notes. You can easily add to the end of your notes with the Append box at the bottom.

The editor supports Markdown, $\LaTeX/ \KaTeX$, syntax highlighting, in-line HTML, table of contents, footnotes, auto-linking, emoji codes, printing/saving to PDF (with and without URLs), custom fonts, optional in-line formatting, autocompletion, search and replace, and more. It is perfect for writing blog posts, class notes, daily journals, to-do checklists, and code snippets. You can append to your notes whenever you need to jot anything down.

This editor works best on the desktop app and web app on a Chromium browser (e.g., Google Chrome or the latest Microsoft Edge) with the No Distraction theme.

Features

Main Features

  • CommonMark and GitHub-flavored Markdown provided by Unified/Remark/Rehype
  • $\LaTeX/\KaTeX$ provided by Remark Math and hosted KaTeX stylesheets
  • Visual Studio Code flavored Syntax Highlighting provided by Rehype Highlight and hosted 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
  • In-line HTML for underlining, highlighting, and HTML rendering provided by Rehype Raw
  • Optional in-line formatting for Markdown provided by CodeMirror
  • Optional dynamic, what-you-see-is-what-you-get live formatting provided by the Rich Markdown Editor developed by Outline. Checkboxes are clickable in view/read-only mode
  • Optional in-line syntax highlighting for Markdown and many other programming languages, intelligent autocompletion, and sophisticated search and replace provided by the Monaco Editor (Visual Studio Code)
    • Languages supported: abap, aes, apex, azcli, bat, c, cameligo, clojure, coffeescript, cpp, csharp, csp, css, dart, dockerfile, fsharp, go, graphql, handlebars, hcl, html, ini, java, javascript, json, julia, kotlin, less, lexon, lua, markdown, mips, msdax, mysql, objective-c, pascal, pascaligo, perl, pgsql, php, plaintext, postiats, powerquery, powershell, pug, python, r, razor, redis, redshift, restructuredtext, ruby, rust, sb, scala, scheme, scss, shell, sol, sql, st, swift, systemverilog, tcl, twig, typescript, vb, verilog, xml, yaml

More Features

  • Emojis provided by Remark emoji and emoji codes
  • Print/Save to PDF the rendered Markdown/HTML text with or without URLs (works best on Chromium browsers)
  • Buttons to scroll to top and bottom of the note
  • Notes are stored in plaintext (great for longevity)
  • Read notes by default to prevent accidentally editing previous notes
  • Append text to notes without accidentally editing previous notes
  • Changes to note in the Edit mode are automatically saved
  • Text in the Append mode is automatically saved without automatically appending
  • Option to render text live while editing
  • Option to turn View mode off to improve editor performance when editing long notes
  • Option to add new line or start new paragraph when appending
  • Option to choose custom fonts and font sizes
  • Helpful questions to prompt writing
  • On Web and Desktop, switching notes does not reset the Edit and View modes, making it easy to edit multiple notes in one session
  • Option to save and load personal default settings

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. In the bottom left corner of the app, click Extensions.
  3. Click Import Extension.
  4. To install the Beta version, paste this into the input box: https://notes.theochu.com/p/mEyBECVK7i or paste this into the input box on desktop: https://raw.githubusercontent.com/TheodoreChu/append-editor/develop/public/beta.ext.json
  5. To install the Alpha version, paste this into the input box: https://notes.theochu.com/p/wVH1OyOI0Y or paste this into the input box on desktop: https://raw.githubusercontent.com/TheodoreChu/append-editor/develop/public/alpha.ext.json
  6. Press Enter or Return on your keyboard.
  7. Click Install.
  8. At the top of your note, click Editor, then click Append Editor - Beta (or Alpha).
  9. When prompted to activate the extension, click Continue.

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

Keyboard Shortcuts

:::note
The keyboard shortcuts should work in Plaintext and CodeMirror editing modes, but most currently do not work in the Dynamic and Monaco editing modes. Better support for keyboard shortcuts will hopefully be improved in the future.
:::

Action Shortcut
Toggle Edit Mode Ctrl/โŒ˜ + E
Toggle Append Mode Ctrl/โŒ˜ + U or Ctrl/โŒ˜ + M
Toggle View Mode Ctrl/โŒ˜ + P
Toggle View and Edit Modes (for Edit Only) Ctrl/โŒ˜ + <
Toggle View and Append Modes Ctrl/โŒ˜ + >
Escape Edit/View Mode^ Escape
Save/Append Text^ Ctrl/โŒ˜ + S and Ctrl/โŒ˜ + Enter
Toggle Append New Line^ Ctrl/โŒ˜ + Alt + N
Toggle Append New Paragraph^ Ctrl/โŒ˜ + Alt + P
Increase number of rows in Append box Ctrl/โŒ˜ + . (period)
Decrease number of rows in Append box** Ctrl/โŒ˜ + , (comma)
Skip to Top/Bottom (fast) Ctrl/โŒ˜ + [ and ]
Skip to beginning or end of text area^ Ctrl/โŒ˜ + Home and Ctrl/โŒ˜ + End
Open Search (in-line formatting mode) Ctrl/โŒ˜ + F or Alt + F (for persistent use)
Close Search Escape or same as open search

^ Perform in corresponding edit box
** The Append box has a minimum of 5 rows

Style Guide

Result Markdown Shortcut*
Bold **text** or __text__ Ctrl/โŒ˜ + B
Emphasize *text* or _text_ Ctrl/โŒ˜ + I
~~Strike-through~~ ~~text~~ Ctrl/โŒ˜ + Alt + U
Link [text](http://) Ctrl/โŒ˜ + K
Image ![text](http://) Ctrl/โŒ˜ + Alt + I
In-line Code `code` Ctrl/โŒ˜ + Alt + K
Code Block ```language

code

```
4 spaces or Ctrl/โŒ˜ + Tab
Unordered List * item

- item

+ item
Ctrl/โŒ˜ + L
Ordered List 1. item Ctrl/โŒ˜ + Alt + L
Task List - [ ] Task or - [x] Task N/A
Blockquote > quote Ctrl + ' or Ctrl + "
H1 # Heading Ctrl/โŒ˜ + H
H2 ## Heading Ctrl/โŒ˜ + H (ร—2)
H3 ### Heading Ctrl/โŒ˜ + H (ร—3)
H4 #### Heading Ctrl/โŒ˜ + H (ร—4)
Section Breaks --- or *** N/A

*The shortcuts are currently available only on the Desktop app and Chrome based web apps such as Google Chrome and the latest Microsoft Edge.

In-line HTML

The Append Editor also supports in-line HTML. You can use <div> </div> tags for formatting sections and <span></span> for formatting text in-line. Here are some examples.

  1. Underlined text:
   <u> Text to be underlined </u>
  1. Highlighted text:
   <span style="background-color: rgb(255, 255, 0);">
     Text to be highlighted
   </span>
  1. Different font families and sizes:
   This is in-line
   <span style="font-family: consolas; font-size: 14px"> monospace</span> text.
   <div style="font-family: Times New Roman; font-size: 12pt">
     This is 12pt Times New Roman for writing papers.
   </div>

Line Breaks

The Markdown rendering in the Append Editor respects line breaks. This is different from the Markdown specification known as CommonMark, which requires two spaces, called trailing spaces, at the end of your line to create a line break without a paragraph break.

In the Append Editor, you do not need trailing spaces. To create a new line, simply press enter/return on your keyboard. To create a new paragraph, skip two lines.

In the Append mode, the New Line checkbox adds two spaces and a new line to the beginning of your note. The New Paragraph checkbox adds two spaces and two new lines to the beginning of your note. If both are checked, new paragraph will take precedence. I am considering to switch these to radio buttons, but that would require at least one option to be checked at all times.

Lists

The Append Editor supports unordered and ordered lists, but does not mix them well if they're both on the first level. Copy this into your editor to see what it renders:

1. First ordered list item
1. Another item.  
   a. Two spaces for lettered list  
   b. Add two trailing spaces to create new lettered item  
   c. Third lettered list
   - Three or four spaces for unordered sub sub list
   - Three or four spaces for unordered sub sub list
   1. Three or four spaces for ordered sub sub list  
      a. Lettered list  
      b. Lettered list
   1. Ordered list on same level

- Unordered List
  1.  Ordered sub list
  - Unordered sub sub list
    - Unordered sub list
      1. Seven spaces for ordered sub sub sub sub list
      1. Seven spaces for ordered sub sub sub sub list
  1. Numbered list doesn't resume

If you want lists to continue automatically when you press Enter, then I recommend using the CodeMirror or Dynamic editing modes.

Tables

Colons can be used to align columns.

Copy this into your editor to see what it renders:

| Tables           |      Are      |   Cool    |
| ---------------- | :-----------: | --------: |
| col 2 is         |   centered    |    \$149   |
| col 3 is         | right-aligned |    \$4.17  |
| privacy is       |    neat       |    \$2.48  |
| rows don't need to  |be pretty|     what? |
| the last line is | unnecessary   |   really?
| one more         |    row        |   Yay! ๐Ÿ˜†

$\KaTeX$

For in-line KaTeX, use single or double dollar signs in-line. For example, $\int_0^\infty f(x)dx$ or $$\pi$$ should yield $\int_0\infty f(x)dx$ and $\pi$.

For display mode KaTeX, use double dollar signs on new lines. For example,:

$$
\int_0^\infty f(x)dx
$$

should yield:

$$
\int_0\infty f(x)dx
$$

$\KaTeX$ Tables

Please see here and here for tables of all the functions and symbols that $\KaTeX$ supports.

Table of Contents

You can create a table of contents:

#### Table of Contents

The links generated by the table of contents do not work properly on mobile. This is an issue with the mobile app and not the editor.

Footnotes

The Append Editor supports footnotes. The footnote links do not work properly on mobile. This is an issue with the mobile app and not the editor. Copy this into your note to see how they're used:

You can create footnote references that are short[^1] or long.[^2]
You can also create them in-line.^[which may be easier,
since you don't need to pick an identifier and move down to type the note]
The footnotes are automatically numbered at the bottom of your note,
but you'll need to manually number your superscripts.
Make sure to count your variable[^variable] footnotes.[^5]

[^1]: Here's a footnote.
[^2]: Here's a footnote with multiple blocks.

    Subsequent paragraphs are indented to show that they belong to the previous footnote.

        { eight spaces for some code }

    The whole paragraph can be indented, or just the first
    line. In this way, multi-paragraph footnotes work like
    multi-paragraph list items.

This paragraph won't be part of the footnote, because it
isn't indented.

[^variable]: The variable footnote is the fourth footnote.
[^5]: This is the fifth footnote.

Printing

Printing and saving to PDF are available on the desktop and web apps. On Windows, the feature works best on a Chromium browser (e.g., Google Chrome or the latest Microsoft Edge) because you can enable Background Graphics such as background colors for highlighting, code snippets, and tables. To make your links clickable in the PDF, click Save to PDF instead of ~~Microsoft Print to PDF~~ when choosing your printer.

Printing URLs

When you click Print, you get to choose whether to print the URLs or not. Printing the URLs will print embedded URLS (https://appendeditor.com/#printing) with their URLs next to them. The URLs for Tables of Contents and Footnotes will also be printed. Not printing the URLs will print the embedded URLs without the URLs next to them. In both cases, the links will be clickable if you choose Save to PDF when choosing your printer as described above.

Settings

You can choose between four editing modes: Plain Textarea, CodeMirror, Dynamic, and Monaco. Each have their own pros and cons and their own use cases.

You can choose your own custom fonts for the Edit/Append and View/Print modes. The Settings Menu has a predefined list of fonts to help you with your selection, but you can type in a different one if it is not on the list. If you choose a font that is unavailable on your device or browser, then the editor might use your device or browser's default font such as Times New Roman.

You can define multiple fonts in the order of your preference and separate them by commas. The editor will automatically display the next font if your preferred font is unavailable. For example, if you want to use a monospace font on all your devices but would prefer not to use Courier New if other monospace fonts are available, then you can submit a list of fonts such as SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace. This is useful if you use many devices with many different operating systems.

The Dynamic mode uses the same fonts for Edit/Append and View/Print, so the custom font option for View/Print is hidden. The Monaco mode does not support custom fonts, so the custom font option for Edit/Append is hidden.

You can also add finer-tuned Custom Styles via CSS.

:::warning
Custom styles from third parties can potentially betray your privacy. Only use styles from trusted sources.
:::

You can also use custom Highlight.js stylesheets for syntax highlighting if you prefer specific themes. The list of all the themes and the link to their stylesheets are available here (the default is the vs theme). For example, if you want to use the Google Code theme, add this to the top of your Custom Styles:

@import url('https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@latest/build/styles/googlecode.min.css');

You can also add custom fonts (e.g., from Google Fonts) to the top of your Custom Styles:

@import url('https://fonts.googleapis.com/css2?family=Open+Sans&display=swap');

Then update your fonts like this:

.CodeMirror,
.DynamicEditor,
.ProseMirror,
#editTextArea,
#appendTextArea,
#renderedNote {
  font-family: 'Open Sans';
}

Make sure to declare @import above/before you declare the font-family.

If you want to edit the font-sizes for the view, edit, and append textareas, you can use this (default is 16px) or use the built-in font size setting:

.CodeMirror,
.DynamicEditor,
.ProseMirror,
#editTextArea,
#appendTextArea,
#renderedNote {
  font-size: 17px;
}

The custom font sizes, font families, and Custom Styles work by adding a <style> element to the end of the <body> element in the HTML. The Custom Styles take precedence over the higher settings because they are lower on the stylesheet.

If you accidentally add hide your settings with CSS (e.g., * {display: none;}), then open the developer inspector, remove the custom stylesheet, and adjust your Settings.

Settings are saved on a per-note basis, but you can save your settings as your personal default for the editor. New notes will use your personal default settings. If you want to use your personal default settings for the old notes, click the refresh/sync button in the second row of the Settings menu.

The styling of the editor (class names, etc.) are subject to change as the editor continues to improve.

Please let me know if you want to add more fonts to the list or need help implementing custom styles.

Development

Prerequisites: Install Node.js, Yarn, and Git on your computer.

The general instructions setting up an environment to develop Standard Notes extensions can be found here. You can also follow these instructions:

  1. Fork the repository on GitHub.
  2. Clone your fork of the repository.
  3. Run cd append-editor to enter the append-editor directory.
  4. Run yarn install to install the dependencies on your machine as they are described in yarn.lock.
  5. In the public directory, create ext.json as explained here with url: "http://localhost:3000/index.html", create ext.json as a copy of sample.ext.json or use the sample.
  6. Install http-server using sudo npm install -g http-server then run yarn server-public to serve the ./public directory at http://localhost:3000.
  7. Install the editor into the web or desktop app with http://localhost:3000/sample.ext.json or with your custom ext.json. Press ctrl/cmd + C to shut down the server.
  8. To run the app in development mode, run yarn start. Press ctrl/cmd + C to exit development mode.
  9. To make the source code prettier, run yarn pretty.
  10. To build the app, run yarn build.
  11. To test the build in the Standard Notes app, run yarn server or install serve using sudo npm install -g serve and run yarn serve then visit http://localhost:3000. Press ctrl/cmd + C to shut down the server.
  12. To the deploy the build into the gh-pages branch of your repository on GitHub, run yarn deploy-stable. I use yarn deploy-dev for deploying development versions of the app and yarn deploy-build for distributing builds.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

License

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

Acknowledgements

Early stages of this editor were based heavily on the Standard Notes Token Vault editor. The Token Vault editor is licensed under AGPL-3.0 and is available for use through Standard Notes Extended.

Further Resources


More fromย ๐Ÿ†“ Append Editor - a free markdown editor for Standard Notes | ๐Ÿ“ Notes by ๐Ÿ˜„ Theo Chu ๐Ÿ‘‹๐Ÿผ