Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
tivie committed Jul 10, 2015
2 parents 91e7b95 + 5aae53f commit 1e2bbcf
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,12 @@ You can also use github CDN directly in your html file(s).

https://cdn.rawgit.com/showdownjs/showdown/<version tag>/dist/showdown.min.js

## Changelog

You can check the full changelog at https://github.com/showdownjs/showdown/blob/master/CHANGELOG.md

## Browser Compatibility

Showdown has been tested successfully with:

* Firefox 1.5 and 2.0
* Chrome 12.0
* Internet Explorer 6 and 7
* Safari 2.0.4
* Opera 8.54 and 9.10
Expand All @@ -54,6 +51,13 @@ Showdown has been tested with node 0.8 and 0.10. However, it should work with pr

If you're looking for showdown v<1.0.0, you can find it in the [**legacy branch**](https://github.com/showdownjs/showdown/tree/legacy).

## Changelog

You can check the full changelog at https://github.com/showdownjs/showdown/blob/master/CHANGELOG.md

## Extended documentation
Check our [wiki pages](https://github.com/showdownjs/showdown/wiki) for examples and a more in-depth documentation.


## Quick Example

Expand All @@ -78,9 +82,7 @@ var converter = new showdown.Converter(),

Both examples should output...

```html
<h1 id="hellomarkdown">hello, markdown!</h1>
```
<h1 id="hellomarkdown">hello, markdown!</h1>

## Options

Expand Down Expand Up @@ -110,7 +112,7 @@ Local options can be set:
* **through the setOption() method**
```js
var converter = new showdown.Converter();
conveter.setOption('optionKey', 'value');
converter.setOption('optionKey', 'value');
```
### Getting an option
Expand All @@ -134,7 +136,7 @@ var myOption = converter.getOption('optionKey');
var showdownGlobalOptions = showdown.getOptions();

//Local
var thisConverterSpecificOptions = conveter.getOptions();
var thisConverterSpecificOptions = converter.getOptions();
```
### Retrieve the default options
Expand Down Expand Up @@ -176,6 +178,10 @@ var defaultOptions = showdown.getDefaultOptions();
ShowdownJS project also provides seamlessly integration with AngularJS via a "plugin".
Please visit https://github.com/showdownjs/ngShowdown for more information.
## Integration with TypeScript
If you're using TypeScript you maybe want to use the types from [DefinitelyTyped](https://github.com/borisyankov/DefinitelyTyped/tree/master/showdown)
## XSS vulnerability
Showdown doesn't sanitize the input. This is by design since markdown relies on it to allow certain features to be correctly parsed into HTML.
Expand Down Expand Up @@ -207,9 +213,9 @@ var showdown = require('showdown'),
## Tests
A suite of tests is available which require node.js. Once node is installed, run the following command from the project root to install the development dependencies:
A suite of tests is available which require node.js. Once node is installed, run the following command from the project root to install the dependencies:
npm install --dev
npm install
Once installed the tests can be run from the project root using:
Expand Down

0 comments on commit 1e2bbcf

Please sign in to comment.