termd
v1.4.0
Published
Render markdown files in the terminal
Downloads
32
Maintainers
Readme
termd
Render Markdown in the Terminal
Preview and render markdown files in the terminal with color syntax highlighting. Also render markdown from a given url
or from a GitHub repository and an npm package.
Installation
npm install -g termd
Usage example
Basic usage
To render a markdown file in the terminal, use the termd
command with the file name or relative path to the markdown file.
termd <filename>
# Example
termd readme.md
....
Commands
--string, -s Use a string with markdown syntax
--url, -u Render markdown from url in the terminal
--npm, -n Render npm package readme in the terminal
--github, -g Render github repository readme in the terminal
Examples
Render a markdown syntax in the terminal
termd --string="## Heading 2"
termd -s ## Heading 2
Heading 2
Render a markdown from a given url
termd --url="https://some.url/with/markdown/file"
termd -u https://some.url/with/markdown/file
...
Render readme of an npm package
termd --npm="termd" # Package name
termd -n termd
...
Render readme of a github repository
termd --github="dephraiim/termd" # Repo Owner / Repo Name
termd -g dephraiim/termd
...
Development setup
To begin developing, do this.
git clone https://github.com/dephraiim/termd.git
cd termd
npm install
Contributing
- Fork it
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
License
MIT © Ephraim Atta-Duncan