Skip to content

cbrincoveanu/techscriptor

Repository files navigation

techscriptor Tweet

Netlify License Stars Forks

Markdown editor for technical writing.

Preview

Techscriptor is a Markdown editor that makes your writing precise and clear.

Techscriptor helps you avoid the following:

  • Long sentences: Make your sentences short and clear.
  • Passive voice: Use the active voice most of the time.
  • Generic expressions: Reduce imprecise, weak, or generic words.
  • Adverbs: Avoid adverbs if they add no significant meaning.

A live demo is available here: https://www.techscriptor.com

Getting Started

You only need a web browser for viewing index.html after cloning the repository to your local machine.

Techscriptor loads its dependencies from CDNs (see below). Other than that, it loads ts.min.js which is the minified1 version of js/techscriptor.js.

Dependencies

Techscriptor depends on the following (loaded from jsdelivr.com and cdnjs.cloudflare.com):

Contribute

Your contributions are always welcome! Please have a look at the contribution guidelines first. 🎉

License

This software is licensed under the MIT license.

Footnotes

  1. minification using https://www.toptal.com/developers/javascript-minifier