# markdown-to-html
**Repository Path**: babyshe/markdown-to-html
## Basic Information
- **Project Name**: markdown-to-html
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-09-03
- **Last Updated**: 2024-09-03
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
markdown-to-html
================
Command-line utility to convert Github Flavored Markdown to HTML.
Output may be to stdout or to your default browser.
Also, the underlying Markdown and GithubMarkdown classes are readable stream classes
and may be used however you like (e.g., pipe to an http response or to stdout).
Includes a demo of a web server app that uses both the classes.
## Installation
#### To use the command line utilities
```
npm install markdown-to-html -g
```
#### To use the Markdown or GithubMarkdown classes in your project
npm install markdown-to-html --save
## Example Usage
#### Command line utility to output HTML to stdout
markdown myfile.md []
#### Command line utility to output HTML to default browser
markdownb myfile.md []
#### Command line utility to output the Github API results to stdout
github-markdown myfile.md []
#### Command line utility to output the Github API results to default browser
github-markdownb myfile.md []
#### Run the web demo
```
git clone https://github.com/cwjohan/markdown-to-html.git
cd markdown-to-html
npm install
npm start
```
In a web browser address field type [localhost:3000](http://localhost:3000).
### Use the Markdown class to render markdown text
```js
var Markdown = require('markdown-to-html').Markdown;
var md = new Markdown();
md.bufmax = 2048;
var fileName = 'test/test.md';
var opts = {title: 'File $BASENAME in $DIRNAME', stylesheet: 'test/style.css'};
...
// Write a header.
console.log('===============================');
// Write a trailer at eof.
md.once('end', function() {
console.log('===============================');
});
md.render(fileName, opts, function(err) {
if (err) {
console.error('>>>' + err);
process.exit();
}
md.pipe(process.stdout);
});
```
## Options for markdown and markdownb
#### `--flavor `
Format as type 'gfm' or just plain 'markdown'. May be abbreviated `-f` on the command line.
Note that for the `github-markdown` utility or the `GithubMarkdown` class it is the 'markdown' flavor that gives you
something resembling the README.md format on Github. Whereas, the 'gfm' flavor gives you something resembling the
the format of comments and issues on Github. This is due to how the Github Markdown API works. On the other hand,
for the `markdown` utility or the `Markdown` class it is virtually the opposite. For example, fenced code blocks
don't work when using the `markdown` utility or the `Markdown` class with the `--flavor markdown` option. This is
due to how the `marked` markdown parser works. The default value for this option is whichever flavor results in
something more like README.md format.
#### `--highlight`
Highlight code blocks with style info. Highlight has no effect in github-markdown.
May be abbreviated `-h` on the command line. Defaults to `false`.
#### `--stylesheet `
Outputs HTML header with link element referring to the given stylesheet.
May be abbreviated `-s` on the command line.
#### `--title `
Outputs HTML header with given title. Title string may include special values
`$FILENAME`, `$DIRNAME`, `$BASENAME`, or `$PATHNAME` variables which are replaced by the
corresponding .md filename, directory name, base name, or full path, respectively.
Alternatively, the title may be any text you wish. May be abbreviated `-t` on the command line.
#### `--context <context>`
Suupply the relevant Github user/project to use with #<n> issue number references. Typically, these are
not used in README.md files but, rather, in comments and issue text on Github.
May be abbreviated `-c` on the command line.
#### `--template <filename or path>`
Optional HTML template file to be used. You can set this template instead of --title and --stylesheet. The only requirement is that the template should contain a token named {markdown} to indicate where the markdown code will be placed.
Example template:
```
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>My own title