https://github.com/timescale/docs-htmltojsx
A fork of react-magic html-to-jsx specifically modified to parse timescale docs
https://github.com/timescale/docs-htmltojsx
Last synced: 8 months ago
JSON representation
A fork of react-magic html-to-jsx specifically modified to parse timescale docs
- Host: GitHub
- URL: https://github.com/timescale/docs-htmltojsx
- Owner: timescale
- License: other
- Created: 2018-12-29T23:36:29.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T18:20:56.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T04:58:55.979Z (8 months ago)
- Language: JavaScript
- Size: 842 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README-htmltojsx.md
- License: LICENSE
Awesome Lists containing this project
README
HTMLtoJSX
=========
HTMLtoJSX converts HTML to JSX for use with [React](facebook.github.io/react/).
Installation
============
```
npm install htmltojsx
```
Alternatively, a web-based version is available at http://facebook.github.io/react/html-jsx.html
Usage
=====
HTMLtoJSX can be used either as a command-line application or as a Node.js module. To use the command-line version, invoke the `htmltojsx` command:
```
$ htmltojsx --help
Converts HTML to JSX for use with React.
Usage: htmltojsx [-c ComponentName] file.htm
Examples:
htmltojsx -c AwesomeComponent awesome.htm Creates React component "AwesomeComponent" based on awesome.htm
Options:
--className, -c Create a React component (wraps JSX in React.createClass call)
--help Show help
```
To use the Node.js module, `require('htmltojsx')` and create a new instance. This is the same interface as the web-based version:
```js
var HTMLtoJSX = require('htmltojsx');
var converter = new HTMLtoJSX({
createClass: true,
outputClassName: 'AwesomeComponent'
});
var output = converter.convert('
Hello world!');
```
Changelog
=========
0.2.6 - 28th November 2016
--------------------------
- [#55](https://github.com/reactjs/react-magic/pull/55) - Handle braces in text. *Thanks to [Solar Olugebefola](https://github.com/solugebefola)*
- [#49](https://github.com/reactjs/react-magic/pull/49) - Fix quotation mark replacement. *Thanks to [Geoffrey Challen](https://github.com/gchallen)*
0.2.5 - 26th October 2015
-------------------------
- [#33](https://github.com/reactjs/react-magic/issues/33) - Correctly handle ``s and `
`s
- [#35](https://github.com/reactjs/react-magic/issues/35) - Handle internal stylesheets (`` tags). *Thanks to [Trevor Copeland](https://github.com/sickslives)*
0.2.4 - 6th August 2015
-----------------------
- [#31](https://github.com/reactjs/react-magic/issues/31) - Fixed `jsdom`
dependency
0.2.3 - 5th August 2015
-----------------------
- [#8](https://github.com/reactjs/react-magic/issues/8) - Handle
case-insensitive attributes and style names
- [#29](https://github.com/reactjs/react-magic/pull/29) - Switch to
`jsdom-no-contextify` to support older versions of Node.js
0.2.2 - 4th May 2015
--------------------
- [#21](https://github.com/reactjs/react-magic/issues/21) - Allow output of
React classes without class name
- [#25](https://github.com/reactjs/react-magic/pull/25) - Update version of
JSDOM
0.2.1 - 1st February 2015
-------------------------
- [#10](https://github.com/reactjs/react-magic/pull/10) - Handle inline CSS
shorthand style values
- [#13](https://github.com/reactjs/react-magic/pull/13) - Maintain valueless
attributes handled by JSX
- [#15](https://github.com/reactjs/react-magic/pull/15) - Use uncontrolled
input fields so they can still be edited
- [#11](https://github.com/reactjs/react-magic/issues/11) - Ensure HTML
entities are handled correctly
0.2.0 - 7th September 2014
--------------------------
- Initial release