| Table of Contents |
|---|
| Features |
| FAQ |
| Development |
| Changelog |
| License |
- Portable Edition
- One single standalone html file, no further dependencies
- Download it to an usb drive and run it from there
- No network connection required
- No data is transferred, so your data are private
- only ~300kB due to hard compression
- Syntax highlighting for code blocks
- Importing of existing Markdown files
- File download of Markdown and generated and prettyfied HTML
- Synchronous Scrolling for long files
- Using localStorage to restore last data if you lost your current browser session
- Partial support for mobile devices, that's the reason why the editor is above the preview
- Inline Syntax highlighting for
- coffeescript
- markdown
- css
- html
- javascript
- perl
- php
- c, c++, objectivec, objective-c, c#, csharp // also known as 'clike'
- python
- sql
- shell
- vb
- xml
- yaml
- Hotkeys
- Bold: CTRL + B
- Emphasis: CTRL + I
Strike through: CTRL + O- H1 to H6: CTRL + 1 to CTRL + 6
- Convert headline to paragraph: CTRL + 0
- Insert Link: CTRL + L
- Insert Code: CTRL + K
- Insert horizontal rule: CTRL + H
- Insert blockquote: CTRL + Q
This application uses the marked library to convert markdown to html. It utilises the markup syntax from github flavored markdown where you also will find some basic examples. If you need the full reference, visit John Gruber's site.
Typically people who read from left to right look to the left side first. So it lets you focus on the result, not on your code.
This application implements modern web technologies. Older browsers which cannot run this app are loosers. Recommendation: use a newer browser.
No!
Please implement it yourself and send me a pull request.
Pull Requests will only accepted if they adapt current source structure and code style.
Before install, make sure you have installed bower, npm and gulp globally.
To begin with development, just type
npm install
in console.
This will also run a gulp task that sets up some file watchers so you can just modify the source files and everything will be compiled together automatically.
The compiled file contains the following resources:
- JavaScript (marked, Angular Light, CodeMirror)
- Compiled and uncss'd CSS
- Embedded Ubuntu Font
Embedded into the application are sources from the following software:
- Bootstrap (MIT-License)
- Bootswatch (MIT-License)
- CodeMirror (MIT-License)
- marked (MIT-License)
- lz-string (MIT-License)
- Ubuntu Font Family Typeface (Ubuntu Font License)
Also thanks to the developers of the following software:
V1.8.0, 20. January 2020:
- refactored code and removed alight to reduce size
- added new languages: shell, vb, yaml
- updated dependencies
V1.7.4, 22. September 2019:
- updated dependencies
V1.7.3, 26. January 2019:
- fixed animation bug
- fixed loading of .md files by adding mime type text/markdown
- added description meta tag
- using typeface-ubuntu npm package instead of own font file
V1.7.2, 26. January 2019:
- fixed bug due to pug migration in last release
- updated more dependencies
- marked all dependencies as devDependencies
- fixed animation in chrome
V1.7.1, 26. January 2019:
- updated dependencies
- migrated gulp-uncss to uncss as gulp-postcss plugin
- fixed animation bug
- replaced jade dependency with pug
V1.7.0, 03. February 2018:
- removed bower, switched to npm
- updated dependencies
- fixed warnings
V1.6.5, 16. May 2016:
- fixed headline shortcuts
V1.6.4, 16. May 2016:
- rewrote gulp build script
V1.6.3, 08. May 2016:
- fixed style whitelist for uncss
- using autoprefixer
V1.6.2, 14. Apr 2016:
- added localStorage persistence layer to keep data
- improved horizontal rule hotkey
- fixed style whitelist for uncss
V1.6.1, 10. Apr 2016:
- bugfixes
V1.6.0, 10. Apr 2016:
- added viewport meta tag
- added hotkeys
- bugfixes
- improved documentation
V1.5.0, 08. Apr 2016:
- enabled codemirror bracket highlighting and bracket auto close plugins
V1.4.3, 07. Apr 2016:
- fixed copyright date
V1.4.2, 07. Apr 2016:
- updated all bower and npm dependencies to current versions and fixed bugs
V1.4.1, 22. Aug 2015:
- improved choppy animation in firefox: force to use hardware acceleration using a very small rotation around Y axis
V1.4, 09. Aug 2015:
- fixed animation to be activated only on h1 element
- fixed lost table styles
- added syntax highlighting for several popular languages
V1.3, 09. Aug 2015:
- fixed scrolling bug in webkit
- fixed placeholder
- added prefixes for animation keyframes for older browsers (especially webkit)
- improved font sizes and font weight of headlines
- added license information for embedded sources
V1.2, 03. Aug 2015:
- fixed lost styles on headlines due to uncss
V1.1, 03. Aug 2015:
- Implemented inline compression using lz-string to compress the whole body tag down to less than 230kB!
V1.0, 02. Aug 2015:
- Initial commit
The MIT License (MIT)
Copyright (c) 2015-2018 Reiner Kempkes
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.