https://github.com/iyashwantsaini/super_readme
A readme for all your projects!
https://github.com/iyashwantsaini/super_readme
readme-bolierplate readme-template
Last synced: 7 months ago
JSON representation
A readme for all your projects!
- Host: GitHub
- URL: https://github.com/iyashwantsaini/super_readme
- Owner: iyashwantsaini
- License: mit
- Created: 2020-09-22T11:52:52.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-13T08:55:51.000Z (about 3 years ago)
- Last Synced: 2025-01-16T22:29:29.694Z (9 months ago)
- Topics: readme-bolierplate, readme-template
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
wolwo
An opensource wallpaper app built using flutter and unsplash API
Key Features •
How To Use •
Download •
Credits •
Related •
License
## [Live demo](http://redocly.github.io/redoc/)
[
](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo--) [
](https://redoc.ly) [
](https://redoc.ly/#services)
## Key Features
* LivePreview - Make changes, See changes
- Instantly see what your Markdown documents look like in HTML as you create them.
* Sync Scrolling
- While you type, LivePreview will automatically scroll to the current location you're editing.
* GitHub Flavored Markdown
* Syntax highlighting
* [KaTeX](https://khan.github.io/KaTeX/) Support
* Dark/Light mode
* Toolbar for basic Markdown formatting
* Supports multiple cursors
* Save the Markdown preview as PDF
* Emoji support in preview :tada:
* App will keep alive in tray for quick usage
* Full screen mode
- Write distraction free.
* Cross platform
- Windows, macOS and Linux ready.
## How To Use
To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/amitmerchant1990/electron-markdownify
# Go into the repository
$ cd electron-markdownify
# Install dependencies
$ npm install
# Run the app
$ npm start
```
Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
## Download
You can [download](https://github.com/amitmerchant1990/electron-markdownify/releases/tag/v1.2.0) the latest installable version of Markdownify for Windows, macOS and Linux.
## Emailware
Markdownify is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at about anything you'd want to say about this software. I'd really appreciate it!
## Credits
This software uses the following open source packages:
- [Electron](http://electron.atom.io/)
- [Node.js](https://nodejs.org/)
- [Marked - a markdown parser](https://github.com/chjj/marked)
- [showdown](http://showdownjs.github.io/showdown/)
- [CodeMirror](http://codemirror.net/)
- Emojis are taken from [here](https://github.com/arvida/emoji-cheat-sheet.com)
- [highlight.js](https://highlightjs.org/)
## Related
[markdownify-web](https://github.com/amitmerchant1990/markdownify-web) - Web version of Markdownify
## Support
Or
## You may also like...
- [Pomolectron](https://github.com/amitmerchant1990/pomolectron) - A pomodoro app
- [Correo](https://github.com/amitmerchant1990/correo) - A menubar/taskbar Gmail App for Windows and macOS
## License
[](/LICENSE)
By [Yashwant](https://github.com/iyashwantsaini)
## Contributors
## Version Guidance
| ReDoc Release | OpenAPI Specification |
|:--------------|:----------------------|
| 2.0.0-alpha.x | 3.0, 2.0 |
| 1.19.x | 2.0 |
| 1.18.x | 2.0 |
| 1.17.x | 2.0 |