Git Product home page Git Product logo

writing's Introduction

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 + SHIFT + D: Toggle dark 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 (CTRL+S), print or save as PDF (CTRL+P), 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, YellowNoiseAudio, etc.

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 People

Contributors

josephernest avatar foopod avatar deepakjois avatar petetnt avatar

Watchers

 avatar James Cloos avatar  avatar

writing's Issues

Cherrypick dark-mode changes

@Steve2955 Here is a commit in my fork which cleans up your patch and just retains the essential changes: 82ffcc6

I don’t want to claim credit for your patch, so it is best if you cherry pick in your code. Here is a list of steps you could follow, if you are having difficulty with Git.

First, add my repo to your remote:

git remote add dj https://github.com/deepakjois/writing

Then reset your master branch to the base commit in the original repo, and cherry-pick my changes (without committing them). and then commit them under your name:

git reset --hard 7045bfbefa63a5540c0dbbb502e488e600f745da
git cherry-pick --no-commit  dj/master
git add .
git commit -m "Enable dark mode changes"

Then do a force push to your remote repo, and the pull request will be automatically updated:

git push -f origin master

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.