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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ build/Release
# Dependency directories
node_modules/
jspm_packages/
package-lock.json

# Typescript v1 declaration files
typings/
Expand All @@ -57,3 +58,5 @@ typings/
# dotenv environment variables file
.env

# documentation artifacts
public/
28 changes: 28 additions & 0 deletions .jsdoc-conf.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"recurseDepth": 3,
"source": {
"includePattern": ".+\\.js$",
"exclude": [
"node_modules",
"dist"
]
},
"tags": {
"dictionaries": [
"jsdoc"
]
},
"templates": {
"monospaceLinks": true,
"default": {
"outputSourceFiles": false,
"useLongnameInNav": true
},
"systemName": "RST2HTML",
"systemSummary": "A JavaScript library that renders reStructuredText to HTML",
"copyright": "Copyright (c) 2017 Troy Howard"
},
"plugins": [
"plugins/markdown"
]
}
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,37 @@ A JavaScript library that renders reStructuredText to HTML.

It also uses Jest as unit testing.

## Testing

A Jest task is set up and configured to run the test case contained in
"lib/rst2html.rst.js":

```js
npm run test
```

## Building

You can build a minimized version of the RST2HTML module on your local machine
by invoking the webpack task. See "webpack.config.js" for configuration
details, but the build itself is straightforward:

```js
npm run build
```

## Installation

```js
npm install rst2html --save
```

## Documentation

The "docs" task will build documentation for this package and place it into the
"public" folder. This can then be opened in your local web browser by
double-clicking the "public/index.html" file.

```js
npm run docs
```
4 changes: 2 additions & 2 deletions dist/rst2html.min.js

Large diffs are not rendered by default.

Loading