josephernest / writing

Writing is a lightweight distraction-free text editor, in the browser (Markdown and LaTeX supported).

Writing

Writing is a lightweight distraction-free text editor, in the browser.

Live version: Writing.

Installation

Just open index.html and that's it! There is no server code. Is that so simple? Yes!

Usage

• CTRL + D: Toggle display mode

• CTRL + P: Print or export as PDF

• CTRL + S: Save source code as .MD file

and a few other commands (change font, etc.) that can be found in:

• CTRL+SHIFT+H or ? bottom-left icon: Show help

Why another Markdown editor? Why not just use StackEdit?

There are many online editors that support Markdown but:

• half of them don't support LaTeX / MathJax (for math formulas)
• some of them do, but have a 1-sec delay between keypress and display, and I find this annoying, see e.g. StackEdit
• some of them have annoying flickering each time you write new text, once math is present on the page
• most of them are not minimalist / distraction-free enough for me

That's why I decided to make Writing:

• open-source
• no server needed, you can run it offline
• fast rendering (no delay when writing / no flickering of math equations)
• just what you need: write, preview, save the code, print or save as PDF, and nothing else
• LPWP website, a.k.a. "Landing Page=Working Page", i.e. the first page that you visit on the website is the page where things actually happen, that means that there is no annoying welcome page or login page, etc.

About

Author: Joseph Ernest (@JosephErnest)

Other projects: BigPicture, bigpicture.js, AReallyBigPage, SamplerBox, Void, TalkTalkTalk, sdfgh, RaspFIP, Yopp, etc.

Sponsoring and consulting

I am available for Python, Data science, ML, Automation consulting. Please contact me on https://afewthingz.com for freelancing requests.

Do you want to support the development of my open-source projects? Please contact me!

I am currently sponsored by CodeSigningStore.com. Thank you to them for providing a DigiCert Code Signing Certificate and supporting open source software.

License

MIT license

Dependencies

Writing uses Pagedown, Pagedown Extra, MathJax, StackOverflow's editor code, and the Computer Modern font.

Note: Some of these libraries have been slightly modified (a few lines of code), to make it work all together, that's why they are included in this package.

writing's Issues

Support dark mode?

I would love to use this in dark mode. Hope it is not very difficult to implement. A possible implementation could be to have a keyboard shortcut to flip the viewing mode.

Support for Org syntax?

Of this request gets enough upvotes, would you consider supporting Org syntax?

Org syntax: http://orgmode.org/worg/dev/org-syntax.html

It's very similar to Markdown if using Org just as a markup.

HTML with MathJax content => PDF, client-side only

Final goal: CTRL+P => triggers download of PDF

Problem: I am unable to render PDF for a page containing MathJax

Related: http://stackoverflow.com/questions/42785850/render-mathjax-into-pdf, http://stackoverflow.com/questions/27706956/render-svg-to-pdf-using-jspdf

Any idea @Purush0th ?

doesn't support Markdown nested lists

the nested list syntax doesnt render as expected

1. this should be a list

• this should be another list
  • this should be a sublist
    1. another one with numbers

It just renders as a flat list in Writing. always creating a new list on every unordered / ordered switch.

Fake bold/italic font styles

Using asterisks or rather the bold/italic markdown syntax results in fake displayed fonts, because the real font styles are missing.

I recommend implementing the missing styles like this:

@font-face {
  font-family: ComputerModern;
  src: url('ComputerModern-Regular.otf') format('otf');
  font-weight: 400;
  font-style: normal;
  font-stretch: normal;
}
@font-face {
  font-family: ComputerModern;
  src: url('ComputerModern-RegularItalic.otf') format('otf');
  font-weight: 400;
  font-style: italic;
  font-stretch: normal;
}
@font-face {
  font-family: ComputerModern;
  src: url('ComputerModern-Bold.otf') format('otf');
  font-weight: 700;
  font-style: normal;
  font-stretch: normal;
}
@font-face {
  font-family: ComputerModern;
  src: url('ComputerModern-BoldItalic.otf') format('otf');
  font-weight: 700;
  font-style: italic;
  font-stretch: normal;
}

Respect cmd key on MacOS

On MacOS native key shortcuts like cmd + s will save an html page instead of Markdown document. When user is using MacOS, application should bind different keys for shortcuts:

CMD + D: Toggle display mode
CMD + P: Print or export as PDF
CMD + S: Save source code as .MD file

etc.

Lacks a notice that javascript is required

fixed by pull request #7

Turn ComputerModern font off when disabling math mode (CTRL+SHIFT+L)

To do: add a CSS class for ComputerModern font, and toggle this class when enabling/disabling MathJax with CTRL+SHIFT+L.

Enhancement : Load or Save to Github Gist

Could look at using the Gist API for this..
https://developer.github.com/v3/gists/

No easy way to access commands without keyboard

When using a device with no physical keyboard (e.g. iPhone, Google Pixel, MS Surface) there is no easy way to access the commands, as there isn't a control key. A button for commands next to the help button seems not too intrusive and very useful.

Change Title Text

I would love functionality to be able to change the <title>Writing</title> text so when I export to pdf I could have the actual title in the upper left corner.

.

local images are not loaded in preview

A local image is not loaded into the preview window. A web image with  works fine in preview.

Bookmark files

Would it be possible to bookmark files, eg, have the local file path as a URL parameter or fragment and load that file on opening? I think it'd be my default Word processor if so.

Uncaught DOMException: Failed to read the 'localStorage' property from 'Window': Access is denied for this document.

I use this in ubuntu google chrome, and the console show Uncaught DOMException: Failed to read the 'localStorage' property from 'Window': Access is denied for this document.

there is nothing show in the right

Screen flickering bug

Consider the following input. I cannot find a smaller input.
No matter what you add afterward, it is going to flicker the last mathjax element.

---
title: Small $L_1$ norm solution to a linear Diophantine equation 
tags: number theory
---

Let $a=(a_1,\ldots,a_n)$ be $n$ integers with $\gcd(a_1,\ldots,a_n)=1$. There exist a integral vector $x=(x_1,\ldots,x_n)$, such that $\sum_{i=1}^n x_ia_i = 1$. How large is the solution $x$? By [Bézout's lemma](https://en.wikipedia.org/wiki/Bézout%27s_identity), when $n=2$, we can obtain that $\|x\|\leq \|a\|$. Here $\|\cdot \|$ is the $L_1$ norm. 

Define $$$...$$$ as $$\begin{eqnarray}...\end{eqnarray}$$

We should implement the ideas given by @dpvc here: mathjax/MathJax#1844