Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ node_modules
*~
*.swp

# JetBrains, MacOS
.idea
*.iml
.DS_Store
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,36 @@ Also, the underlying Markdown and GithubMarkdown classes are readable stream cla
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.

---
## Updated in fork
- Process markdown from string:
- Was:
```javascript
let filename = 'test.md'
markdown.renderFromString(filename, opts, function (err) {
if (err) {
console.error('>>>' + err);
process.exit();
}

// handle stream
});
```
- And now:
```javascript
markdown.renderFromString("# Test pls", opts, function (err) {
if (err) {
console.error('>>>' + err);
process.exit();
}

// same stream handling
});
```
- Some code refactoring (removed unnecessary dependencies, removed test files, `var` -> `let` etc)

---

## Installation

#### To use the command line utilities
Expand Down
3 changes: 1 addition & 2 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
exports.Markdown = require('./lib/markdown.js');

exports.GithubMarkdown = require('./lib/github-markdown.js');

exports.GithubMarkdown = require('./lib/github-markdown.js');
Loading