mrkdown/README.md

Markdown files to HTML static site generator - angular.js app

## Markdown files to static SPA Angular.js Application Generator

[Demo Video](https://firebasestorage.googleapis.com/v0/b/aboutsujith.appspot.com/o/mrkdown-npm-app-video1.mp4?alt=media&token=31a44b92-2ade-4455-b73d-d9e20b79e333)

<!-- ![Demo Gif](https://firebasestorage.googleapis.com/v0/b/aboutsujith.appspot.com/o/mrkdown-npm-app-video1.gif?alt=media&token=cee5b25e-01d7-4a0f-a437-17f6ba7ce5ee) -->

<!-- <figure class="video_container">
  <iframe style="width: 620px;height: 349px;" src="https://firebasestorage.googleapis.com/v0/b/aboutsujith.appspot.com/o/mrkdown-npm-app-video1.mp4?alt=media&token=31a44b92-2ade-4455-b73d-d9e20b79e333" frameborder="0" allowfullscreen="true"> </iframe>
</figure> -->

#### Must Install `mrkdown` package.
```cmd
npm install -g mrkdown
```
### Create a config file
```cmd
mrkdown init
```

### Convert All markdown file to HTML
```cmd
mrkdown build
```
### Conversion 
| From File | To File |
| --------- | ------- |
| md        | html    |
| html      | html    |
| htm       | html    |
| txt       | html    |

## Commands
### Command - `Init` 
**`mrkdown init`**, it will create a new `mrkdown.config.json` file.  
```json
{
    "distFolderName": "dist",
    "title": "My Notes",
    "brandName": "My Notes",
    "favIconUrl": "Image/image.png",
    "users": [
        {
            userName: "Admin",
            password: "admin@123",
            displayName: "Admin",
            imageUrl: "Image/image.png"
        }
    ],
    "useHash": true
}
```
### mrkdown.config.json
| Key                | Meaning                                      | Default                  |
| ------------------ | -------------------------------------------- | ------------------------ |
| removeRightSideBar | removing the right side bar                  | true                     |
| distFolderName     | build file will be there                     | "markdown-publish"       |
| title              | browser tab title                            | "Notes"                  |
| favIconUrl         | fav icon url                                 | NULL                     |
| skipFolders        | conversion not applied those specified paths | ['.git', 'node_modules'] |
| skipFiles          | conversion not applied those specified files | []                       |
| home               | it will enable the default home page setup   | false                    |
| homeHtml           | accept RAW html                              | NULL                     |
| homeHtmlUrl        | Home page html file                          | NULL                     |
| users              | Give the users to access you wep page        | []                       |
| useHash            | it will enable the hash in the URL           | true                     |
| prod               | minified all the files                       | false                    |

### Command - `Build`
**`mrkdown build`**, it will convert all Markdown file to HTML file.  
**`mrkdown build --use-hash=true`**, enable the # in URL  
**`mrkdown build --use-hash=false`**, remove the #! in URL
**`mrkdown build --use-hash=false --prod`**, remove the #! in URL and minified the files