Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mobily/markdown-live
Markdown preview with live update.
https://github.com/mobily/markdown-live
Last synced: 3 months ago
JSON representation
Markdown preview with live update.
- Host: GitHub
- URL: https://github.com/mobily/markdown-live
- Owner: mobily
- Archived: true
- Created: 2014-12-03T22:45:47.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-22T03:01:58.000Z (over 8 years ago)
- Last Synced: 2024-04-26T12:47:38.714Z (7 months ago)
- Language: JavaScript
- Size: 2.63 MB
- Stars: 343
- Watchers: 18
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markdown-live
> Markdown preview with live update.
## Contents
* [Screencasts](#screencasts)
* [Installation](#installation)
* [Usage](#usage)
* [CLI](#cli)
* [Contributions](#contributions)
* [Contact](#contact)
* [Changelog](#changelog)
* [License](#license)
## Screencasts
## Installation
```shell
$ npm install -g markdown-live
```
## Usage
To list all available options:
```shell
$ mdlive --help
```
To run with custom port and directory:
```shell
$ mdlive --port 1024 --dir [PATH]
```
To watch markdown files outside the current directory:
```shell
$ mdlive --file [, FILE]
```
To set another socket.io hostname:
```shell
$ mdlive --socket "http://127.0.0.1:8080"
```
## CLI
```shell
USAGE: mdlive [OPTIONS]
OPTIONS:
-h, --help Show this message and exit.
-d, --dir Specifies the directory to find markdown files (default: current directory).
-f, --file Specifies markdown files to watch.
-p, --port Specifies the port to use (default: 2304).
-v, --verbose Provides debug messages.
-s, --socket Specifies the socket.io hostname or IP address (default: http://localhost)
```
```shell
AVAILABLE MARKDOWN EXTENSIONS:
*.markdown
*.mdown
*.mkdn
*.md
*.mkd
*.mdwn
*.mdtxt
*.mdtext
```
## Contributions
- Fork repository
- Create feature- or bugfix-branch
- Create pull request
- Use Github Issues
## Contact
- Marcin Dziewulski,
- Twitter: [@marcinmobily](https://twitter.com/marcinmobily)
## Changelog
```
2015-01-17 1.0.8 added support for alternate filename extensions
added support for setting socket.io hostname or IP address
2014-12-09 1.0.6 watch *.md files outside the current directory (option: --file)
2014-12-08 1.0.5 better code highlighting
2014-12-03 1.0.0 initial version
```
## License
The MIT License (MIT)
Copyright (c) 2014 Marcin Dziewulski
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.