Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
fredysomy committed Nov 13, 2020
1 parent 11485f4 commit 935f812
Show file tree
Hide file tree
Showing 25 changed files with 1,936 additions and 228 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules
node_modules
build
122 changes: 121 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,121 @@
# MarkdownEditor-Desktop
<p align="center">
<a href="https://github.com/fredysomy/HealthApp">
<img
alt="Healthapp"
src="https://github.com/fredysomy/electron-auto-update/blob/master/cd.png?raw=true"
width="400"
height="400"
/>
</a>
</p>

# <h1 align=center>MarkdownIt</h1>
#### <h5 align=center>A Efficent Code Editor to live render Markdown and Can save the rendered file as **Markdown**,**Html** and **Pdf** . Also Instant Hosting in The Web</h5>
<p align="center">
<img src="https://img.shields.io/badge/MarkdownIt-v1.0.2-green"></img>
<img src="https://img.shields.io/github/stars/fredysomy/MarkdownIt"></img>
<img src="https://img.shields.io/github/license/fredysomy/HealthApp"></img>
<img src="https://img.shields.io/github/forks/fredysomy/HealthApp"></img>
<img src="https://img.shields.io/github/issues/fredysomy/HealthApp"></img>



</p>

***

<div align="center">
<img src="https://drive.google.com/uc?export=view&id=1CWP-yFwqgy2HKbbHctxHbOW63hwJ4oqX" width=80%>
</div>

***

<p align=center>
<a href="#features"> Features</a>
<a href="#MarkdownItHost"> MarkdownItHost</a>
<a href="#downloads"> Downloads</a>
<a href="https://markdownitweb.herokuapp.com/markdownit-8249">Guide</a>


</p>

<h3 id="features" >Features</h3>

* Live preview of the changes you make
* You can save the file and open any md files in the editor.
* You can save convert the markdown you have written into html and pdf.
* Uses Ace editor
* Bootstrap styling is enabled
* You can change the editor themes and text colors for your preference
* There is a settings.json file to handle all themes and style changes
* Html tags can be used with the markdown.
* The pdf file generated is also html friendly.
* Clean UI and also have a reference for markdown.
* `Has instant web hosting feature.`
* [You can create a static single paged website in this editor.](#MarkdownItHost)
* MarkdownItHost is the service in the editor that allows you to host websites.


<h3 id="MarkdownItHost" >MarkdownItHost</h3>

* A simple way to host websites (included in the code editor)
* One can create a webpage with one click [See here](https://markdownitweb.herokuapp.com/markdownit-dc7f)
* A config file with the path name of your website and unique secret id is to be saved in your PC.
* Only with the config file you can edit and publish your site.
* Deploys a Static website within 2 seconds.(With 2-3 clicks).
* Any bugs or queries can be mailed to [me](mailto:[email protected])
* All the "HOW to" guide is included [Here]()
* `You can use Bootstrap styling inside the code you Write ( no need to inculde the scripts)`
### How to use(Source code)
<br>


##### Clone this repository
```
git clone https://github.com/fredysomy/MarkdownIt
```
##### Install dependencies
```
npm install
```
##### Run the app
```
npm start
```


<br>

## Changelog
#### `v1.0.0`
* Added code editor
* Added file saving
* Aditional options like save as pdf and save as html.
#### `v1.0.2`
* Added MarkdownItHost to publish static websites
* Online offline alerts.

## Contibute
* Fork the repostory
* install the dependencies
* Make your changes
* And make a pull request from your repo. (I will surely look forward for the PR's)
## Made with
* Electron
* Ace js
* markdown-pdf

***

<div align="center">

<footer>&copy; Copyright 2020 ,MarkdownIt (Fredy Somy).</footer>


</div>

***
93 changes: 93 additions & 0 deletions guide/HELPME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<p align="center">
<a href="https://github.com/fredysomy/HealthApp">
<img
alt="Healthapp"
src="https://github.com/fredysomy/electron-auto-update/blob/master/cd.png?raw=true"
width="400"
height="400"
/>
</a>
</p>

# <h1 align=center>MarkdownIt-Guide</h1>
#### <h5 align=center>A Efficent Code Editor to live render Markdown and Can save the rendered file as **Markdown**,**Html** and **Pdf**.Also Instant Hosting for static single paged websites.</h5>
<p align="center">
<img src="https://img.shields.io/badge/MarkdownIt-v1.0.2-green"></img>
<img src="https://img.shields.io/github/stars/fredysomy/HealthApp"></img>
<img src="https://img.shields.io/github/license/fredysomy/HealthApp"></img>
<img src="https://img.shields.io/github/forks/fredysomy/HealthApp"></img>
<img src="https://img.shields.io/github/issues/fredysomy/HealthApp"></img>



</p>

## `Editor`

***

<img src="https://drive.google.com/uc?export=view&id=1F3ReX5Ej7Z3P2VZDnJ-ZYszMRQauOU9x" width="100%">

***

* The left window is the editor where you can edit the markdown.
* The right window live previews the changes you made in the editor.

***

<img src="https://drive.google.com/uc?export=view&id=1XErneMVVsWWCddvbdoF-3WHGMKS76P1C" width="100%">

***

* The SAVE AS button allows you to save your .md files.
* With OPEN FILE you can open any .md files to edit.
* SAVE AS PDF allows you to convert the markdown you wrote in editor to pdf.
* SAVE AS HTML allows you to convert the markdown you wrote in editor to html format.
* Settings button gives you access to change theme of editor.

## `Settings`

***

<img src="https://drive.google.com/uc?export=view&id=1jpMMY1kAMsp-7jpoEXIo2rbZSsi_NmtV" width="100%">

***

* You can change the theme of the editor to various themes available.
* You can also change the background and text color.( Refer image above ).

***

# `MarkdownItHost`
***
##### Web hosting service inside MarkdownIt.
***
<img src="https://drive.google.com/uc?export=view&id=1NmnRInPHcfwn0MpR9pKf0_NkU5OF-6Tj" width="100%">

***

* You can create a new website with the CREATE SITE button.
* Instant publishing can be done using PUBLISH button.
* You can edit any websites you made (provided you have the config file for the respective website in your system).

***

### `For more explanation watch the gif below.`

***

<img src="http://drive.google.com/uc?export=view&id=1rSRo7hfEeITO9p8zErd4hJRAPWsMdSKJ" width="100%">

***


## `Contact`

***

* Feel free to email [me](mailto:[email protected]) for Bugs Found or queries.
* I will be happy to help.

<div align="center">
<footer> <large>&copy; Copyright 2020, MarkdownIt ( Fredy Somy )</large> </footer>
</div>
Binary file added help/notable.pdf
Binary file not shown.
Binary file added icons/256x256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added icons/cd.ico
Binary file not shown.
Binary file added icons/ico.icns
Binary file not shown.
32 changes: 0 additions & 32 deletions main.html

This file was deleted.

Loading

0 comments on commit 935f812

Please sign in to comment.