- JavaScript 93%
- HTML 7%
|
|
||
|---|---|---|
| .forgejo/workflows | ||
| android-chrome-192x192.png | ||
| android-chrome-512x512.png | ||
| apple-touch-icon.png | ||
| cmunrb.otf | ||
| cmunrm.otf | ||
| favicon-16x16.png | ||
| favicon-32x32.png | ||
| favicon.ico | ||
| FiraCode-Bold.woff2 | ||
| FiraCode-Regular.woff2 | ||
| index.html | ||
| Markdown.Converter.js | ||
| Markdown.Editor.js | ||
| Markdown.Extra.js | ||
| Markdown.Sanitizer.js | ||
| mathjax-editing_writing.js | ||
| README.md | ||
| site.webmanifest | ||
Writing
Writing is a lightweight distraction-free text editor. Modified with dark mode & better typography.
Modifications
This fork includes:
- Dark mode by default with enhanced color scheme
- Modern typography: System font stack for preview (Inter, SF Pro, Segoe UI, etc.)
- Fira Code font for the editor with programming ligatures
- Automatic title updates: Page title automatically changes to match your first heading
- Removed TeX Roman font (LaTeX support still available)
- Automatic deployment via GitHub Actions
Installation
Just open index.html and that's it! There is no server code. Is that so simple? Yes!
Deployment
This repository includes a GitHub Actions workflow for automatic deployment to a server.
Required GitHub Secrets
Configure these in your repository settings (Settings → Secrets and variables → Actions):
DEPLOY_SSH_KEY- Private SSH key for server accessDEPLOY_HOST- Server hostname or IP addressDEPLOY_USER- SSH usernameDEPLOY_PORT- SSH port (optional, defaults to 22)DEPLOY_PATH- Path on server where the app should be deployed (e.g.,/var/www/writing)FORGEJO_TOKEN- OAuth token for git repository access
Deployment Triggers
The workflow automatically deploys when:
- Code is pushed to the
mainbranch - Manually triggered via GitHub Actions UI (workflow_dispatch)
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 Fira Code 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.