¿Cómo renderizo Markdown desde un componente React?

Question 1

Tengo mi documentación escrita en Markdown y me gustaría convertir esos archivos de mi código JSX (ES6+CommonJS) en componentes React. ¿Cómo puedo conseguir esto?

Por ejemplo, tengo styles.markdown y me gustaría convertirlo en un <p> etiqueta.

Question 2

Puedes usar React-Markdown:

const React = require('react')
const ReactDOM = require('react-dom')
const ReactMarkdown = require('react-markdown')

const input="# This is a header\n\nAnd this is a paragraph"

ReactDOM.render(<ReactMarkdown source={input} />, document.getElementById('container'))

O… Puede simplemente crear un componente React simple que envuelva una llamada a un analizador Markdown. Hay dos muy buenos para JavaScript:

Ahora, puede crear un componente como este:

var MarkdownViewer = React.createClass({
    render: function() {
        // pseudo code here, depends on the parser
        var markdown = markdown.parse(this.props.markdown);
        return <div dangerouslySetInnerHTML={{__html:markdown}} />;
    }
});

Ya había uno, pero parece que ya no se mantiene: https://github.com/tcoopman/markdown-react

Además, si necesita un React Markdown Editor, consulte: reaccionar-mde. Descargo de responsabilidad: soy el autor.

Question 3

El paquete react-markdown con Markdown El componente será una buena elección:

import React from 'react'
import Markdown from 'react-markdown'
    
var src = "# This is markdown document"
    
React.render(
  <Markdown children={src} />,
  document.getElementById('root')
)

Puede escribir en su lugar aquí-docs como este:

<Markdown>
  # Header

  * dotted lists
  * [url](/doc)
</Markdown>

Es posible especificar transformadores para link-urls e image-urls y mucho más.

Question 4

Llegué un poco tarde a la fiesta, pero escribí una biblioteca competidora de las mencionadas anteriormente que tiene el beneficio adicional de no necesitar el dangerouslySetInnerHtml cortar a tajos: https://github.com/probablyup/markdown-to-jsx

Question 5

Ejemplo de componente Markdown que representa html a partir de texto de descuento, la lógica de carga de datos debe implementarse en una tienda separada/componente principal/lo que sea. estoy usando marcado paquete para convertir markdown a html.

import React from 'react';
import marked from 'marked';

export default class MarkdownElement extends React.Component {
  constructor(props) {
    super(props);

    marked.setOptions({
      gfm: true,
      tables: true,
      breaks: false,
      pedantic: false,
      sanitize: true,
      smartLists: true,
      smartypants: false
    });
  }
  render() {
    const { text } = this.props,
      html = marked(text || '');

    return (<div>
      <div dangerouslySetInnerHTML={{__html: html}} />
    </div>);
  }
}

MarkdownElement.propTypes = {
  text: React.PropTypes.string.isRequired
};

MarkdownElement.defaultProps = {
  text: ''
};

Question 6

Prueba algo como esto:

import fs from 'fs';
import React, { Component, PropTypes } from 'react';

class Markdown extends Component {
    constructor() {
        super(props);
        this.state = { contents: '' };
        this.componentDidMount = this.componentDidMount.bind(this);
    }

    componentDidMount() {
        const contents = fs.readFileSync(this.props.path, 'utf8');
        this.setState({ contents });
    }

    render()
        return (
            <div>
                {this.state.contents.split('\n').map((line, i) =>
                    line ? <p key={i}>{line}</p> : <br key={i} />)}
            </div>
        );
    }
}

Markdown.propTypes = { path: PropTypes.string.isRequired };

React.render(<Markdown path="./README.md" />, document.body);

O si está utilizando las funciones de ES7+:

import fs from 'fs';
import React, { Component, PropTypes } from 'react';

class Markdown extends Component {
    static propTypes = { path: PropTypes.string.isRequired };

    state = { contents: '' };

    componentDidMount = () => {
        const contents = fs.readFileSync(this.props.path, 'utf8');
        this.setState({ contents });
    };

    render() {
        return (
            <div>
                {this.state.contents.split('\n').map((line, i) =>
                    line ? <p key={i}>{line}</p> : <br key={i} />)}
            </div>
        );
    }
}

React.render(<Markdown path="./README.md" />, document.body);

Necesitarás usar el brfs transforme para poder usar fs.readFileSync si se está ejecutando en el lado del cliente.

¿Ha sido útil esta solución?