react markdown preview

Reaja a visualização de marcação

Reactar o texto de marcação de visualização do componente no navegador da web. A quantidade mínima de CSS para replicar o estilo de marcação do GitHub. O site atual do documento é convertido usando este componente React.

Características

• ? Apoie o modo escuro/modo noturno. @v4
• ?? ‍♂️ estilo github: o conteúdo de marcação é renderizado o mais próximo possível da maneira como é possível no github.
• ?? ‍♂️ Suporte GFM (Literais Autolink, notas de rodapé, Strikethrough, mesas, listas de tarefas).
• ? Suporte a destaque do bloco de código automático.
• ? Suporte para definir estilos por meio de comentários.
• ⛳️ Suporte para notas de rodapé da GFM
• ⛳️ Suporte para alerta do GitHub

Início rápido

$ npm install @uiw/react-markdown-preview --save

Exemplo de uso

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
## MarkdownPreview

> todo: React component preview markdown text.
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview source = { source } style = { { padding : 16 } } />
  )
} 

Desativar links de cabeçalho

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
## MarkdownPreview

## Header 2

### Header 3
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      rehypeRewrite = { ( node , index , parent ) => {
        if ( node . tagName === "a" && parent && / ^h(1|2|3|4|5|6) / . test ( parent . tagName ) ) {
          parent . children = parent . children . slice ( 1 )
        }
      } }
    />
  ) ;
} 

linha de destaque

Sintaxe: ```jsx {1,4-5}

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
```js {2}
function () {
  console.log('hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello')
}
```
```js {2}
function () {
  console.log('hello ')
}
```
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      rehypeRewrite = { ( node , index , parent ) => {
        if ( node . tagName === "a" && parent && / ^h(1|2|3|4|5|6) / . test ( parent . tagName ) ) {
          parent . children = parent . children . slice ( 1 )
        }
      } }
    />
  ) ;
} 

Mostrar números de linha

Sintaxe: ```jsx showLineNumbers {1,4-5}

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
```js showLineNumbers
function () {
  console.log('hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello')
}
```
```js showLineNumbers {2}
function () {
  console.log('hello ')
}
```
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      rehypeRewrite = { ( node , index , parent ) => {
        if ( node . tagName === "a" && parent && / ^h(1|2|3|4|5|6) / . test ( parent . tagName ) ) {
          parent . children = parent . children . slice ( 1 )
        }
      } }
    />
  ) ;
} 

Destaque de código

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
```js
function () {
  console.log('hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello')
}
```
```js
function () {
  console.log('hello ')
}
```
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview source = { source } style = { { padding : 16 } } />
  ) ;
} 

Remova o destaque do código

O exemplo a seguir pode ajudá -lo a excluir o código que destaca o código de ser incluído no pacote. @uiw/react-markdown-preview/nohighlight não contém o pacote de destaque do Código rehype-prism-plus , showLineNumbers e Funções highlight line não funcionarão mais. (#586)

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview/nohighlight' ;

const source = `
```js
function () {
  console.log('hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello hello')
}
```
```js
function () {
  console.log('hello ')
}
```
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      rehypeRewrite = { ( node , index , parent ) => {
        if ( node . tagName === "a" && parent && / ^h(1|2|3|4|5|6) / . test ( parent . tagName ) ) {
          parent . children = parent . children . slice ( 1 )
        }
      } }
    />
  ) ;
} 

Ignorar

Ignore a exibição de conteúdo por meio de comentários HTML, mostrados no GitHub ReadMe, excluído no HTML.

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
<!--rehype:ignore:start-->
Content ignored
<!--rehype:ignore:end-->
Some content is ignored, please check the source code
` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      rehypeRewrite = { ( node , index , parent ) => {
        if ( node . tagName === "a" && parent && / ^h(1|2|3|4|5|6) / . test ( parent . tagName ) ) {
          parent . children = parent . children . slice ( 1 )
        }
      } }
    />
  ) ;
} 

 <!-- rehype:ignore:start --> Ignored content <!-- rehype:ignore:end --> 

Apoie a visualização Katex personalizada

A Katex é uma biblioteca JavaScript rápida e fácil de usar para a renderização de matemática da Tex na web, realizamos a renderização de matemática através KaTeX .

npm install katex

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;
import { getCodeString } from 'rehype-rewrite' ;
import katex from 'katex' ;
import 'katex/dist/katex.css' ;

const source = `This is to display the 
`$$c = \pm\sqrt{a^2 + b^2}$$`
 in one line

```KaTeX
c = \pm\sqrt{a^2 + b^2}
```
` ;

export default function Demo ( ) {
  const [ value , setValue ] = React . useState ( source ) ;
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      components = { {
        code : ( { children = [ ] , className , ... props } ) => {
          if ( typeof children === 'string' && / ^$$(.*)$$ / . test ( children ) ) {
            const html = katex . renderToString ( children . replace ( / ^$$(.*)$$ / , '$1' ) , {
              throwOnError : false ,
            } ) ;
            return < code dangerouslySetInnerHTML = { { __html : html } } style = { { background : 'transparent' } } /> ;
          }
          const code = props . node && props . node . children ? getCodeString ( props . node . children ) : children ;
          if (
            typeof code === 'string' &&
            typeof className === 'string' &&
            / ^language-katex / . test ( className . toLocaleLowerCase ( ) )
          ) {
            const html = katex . renderToString ( code , {
              throwOnError : false ,
            } ) ;
            return < code style = { { fontSize : '150%' } } dangerouslySetInnerHTML = { { __html : html } } /> ;
          }
          return < code className = { String ( className ) } > { children } </ code > ;
        } ,
      } }
    />
  ) ;
} 

Apoie a prévia de sereia personalizada

Usando sereia para geração de diagrama e fluxograma do texto de uma maneira semelhante à marcação

 import React , { useState , useRef , useEffect , Fragment , useCallback } from "react" ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;
import { getCodeString } from 'rehype-rewrite' ;
import mermaid from "mermaid" ;

const randomid = ( ) => parseInt ( String ( Math . random ( ) * 1e15 ) , 10 ) . toString ( 36 ) ;
const Code = ( { inline , children = [ ] , className , ... props } ) => {
  const demoid = useRef ( `dome ${ randomid ( ) } ` ) ;
  const [ container , setContainer ] = useState ( null ) ;
  const isMermaid = className && / ^language-mermaid / . test ( className . toLocaleLowerCase ( ) ) ;
  const code = props . node && props . node . children ? getCodeString ( props . node . children ) : children [ 0 ] || '' ;

  const reRender = async ( ) => {
    if ( container && isMermaid ) {
      try {
        const str = await mermaid . render ( demoid . current , code ) ;
        container . innerHTML = str . svg ;
      } catch ( error ) {
        container . innerHTML = error ;
      }
    }
  }

  useEffect ( ( ) => {
    reRender ( )
  } , [ container , isMermaid , code , demoid ] ) ;

  const refElement = useCallback ( ( node ) => {
    if ( node !== null ) {
      setContainer ( node ) ;
    }
  } , [ ] ) ;

  if ( isMermaid ) {
    return (
      < Fragment >
        < code id = { demoid . current } style = { { display : "none" } } />
        < code ref = { refElement } data-name = "mermaid" />
      </ Fragment >
    ) ;
  }
  return < code > { children } </ code > ;
} ;
const source = `The following are some examples of the diagrams, charts and graphs that can be made using Mermaid and the Markdown-inspired text specific to it. 

```mermaid
graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
` ;
// const source = `
// ```mermaid
// graph TD;
//     A-->B;
//     A-->C;
//     B-->D;
//     C-->D;
// ```
// `;

export default function Demo ( ) {
  return (
    < MarkdownPreview
      source = { source }
      style = { { padding : 16 } }
      components = { {
        code : Code
      } }
    />
  ) ;
} 

Segurança

Por favor, observe que o Markdown precisa ser higienizado se você não confiar completamente em seus autores. Caso contrário, seu aplicativo é vulnerável ao XSS. Isso pode ser alcançado adicionando o rehype-sanitize como um plug-in.

 import React from 'react' ;
import rehypeSanitize from "rehype-sanitize" ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `
## MarkdownPreview

**Hello world!!!** <IFRAME SRC="javascript:javascript:alert(window.origin);"></IFRAME>

<!-- test --> 123

<!-- test --> 456 <!-- test -->
` ;

const rehypePlugins = [ rehypeSanitize ] ;
export default function Demo ( ) {
  return (
    < MarkdownPreview source = { source } rehypePlugins = { rehypePlugins } style = { { padding : 16 } } />
  )
} 

Adereços de opções

 import { ReactMarkdownProps } from 'react-markdown' ;
import { RehypeRewriteOptions } from 'rehype-rewrite' ;

type MarkdownPreviewProps = {
  prefixCls ?: string ;
  className ?: string ;
  source ?: string ;
  disableCopy ?: boolean ;
  style ?: React . CSSProperties ;
  pluginsFilter ?: ( type : 'rehype' | 'remark' , plugin : PluggableList ) => PluggableList ;
  wrapperElement ?: React . DetailedHTMLProps < React . HTMLAttributes < HTMLDivElement > , HTMLDivElement > & {
    'data-color-mode' ?: 'light' | 'dark' ;
  } ;
  onScroll ?: ( e : React . UIEvent < HTMLDivElement > ) => void ;
  onMouseOver ?: ( e : React . MouseEvent < HTMLDivElement > ) => void ;
  rehypeRewrite ?: RehypeRewriteOptions [ 'rewrite' ] ;
} & ReactMarkdownProps ;

• source ( string , padrão: '' )
  Markdown para analisar
• className ( string? )
  Enrole a remarcação em uma div com este nome de classe

Isso ReactMarkdownProps detalhes. Atualizar react-markdown v9

• children ( string , padrão: '' )
  Markdown para analisar
• className ( string? )
  Enrole a remarcação em uma div com este nome de classe
• skipHtml ( boolean , padrão: false -> true )
  Ignore HTML em Markdown completamente
• allowElement ( (element, index, parent) => boolean? opcional)
  Função chamada para verificar se um elemento é permitido (quando verdadeiro) ou não. allowedElements / disallowedElements é usada primeiro!
• remarkPlugins ( Array.<Plugin> , padrão: [] )
  Lista de plugins de observação a serem usados. Veja a próxima seção para obter exemplos sobre como passar as opções
• rehypePlugins ( Array.<Plugin> , padrão: [] )
  Lista de plug -ins de reprodução a serem usados. Veja a próxima seção para obter exemplos sobre como passar as opções

Observação

Atualizar o react-markdown v8 para v9

Adicione urlTransform

Os transformImageUri e transformLinkUri foram removidos. Ter duas funções é um pouco demais, principalmente porque há mais URLs que você pode querer mudar (ou que podem ser inseguros, por isso os tornamos seguros). E o nome deles e as APIs eram um pouco estranhos. Você pode usar o novo suporte urlTransform para alterar todos os seus URLs.

Remova linkTarget

A opção linkTarget foi removida; Você provavelmente não deve definir metas. Se você quiser, use rehype-external-links .

Remova includeElementIndex

A opção includeElementIndex foi removida, portanto, index nunca é passado para componentes. Escreva um plugin para passar index :

Mostrar exemplo de plugin

 import { visit } from 'unist-util-visit'

function rehypePluginAddingIndex ( ) {
  /**
   * @param {import('hast').Root} tree
   * @returns {undefined}
   */
  return function ( tree ) {
    visit ( tree , function ( node , index ) {
      if ( node . type === 'element' && typeof index === 'number' ) {
        node . properties . index = index
      }
    } )
  }
}

Remova rawSourcePos

A opção rawSourcePos foi removida, para que sourcePos nunca seja passado para componentes. Todos os componentes passam node , para que você possa obter node.position .

Remova sourcePos

A opção sourcePos foi removida, para que data-sourcepos nunca sejam passados para elementos. Escreva um plugin para passar index :

Mostrar exemplo de plugin

 import { stringifyPosition } from 'unist-util-stringify-position'
import { visit } from 'unist-util-visit'

function rehypePluginAddingIndex ( ) {
  /**
   * @param {import('hast').Root} tree
   * @returns {undefined}
   */
  return function ( tree ) {
    visit ( tree , function ( node ) {
      if ( node . type === 'element' ) {
        node . properties . dataSourcepos = stringifyPosition ( node . position )
      }
    } )
  }
}

Remova adereços extras passados para determinados componentes

Ao substituir os componentes, esses adereços não são mais passados:

• inline no code - crie um plugin ou use pre para o bloco
• level em h1 , h2 , h3 , h4 , h5 , h6 - Verifique node.tagName em vez
• checked em li -Verifique a classe task-list-item ou verifique props.children
• index em li - Crie um plugin
• ordered em li - crie um plug -in ou verifique o pai
• depth em ol , ul - crie um plugin
• ordered no ol , ul - verifique node.tagName
• isHeader em td , th - check node.tagName em vez
• isHeader no tr - Crie um plugin ou verifique as crianças

Recursos de marcação

Suporta o estilo CSS

Use Comentários HTML <!--rehype:xxx--> para deixar o Markdown Suporte Style Customization.

 ## Title
<!-- rehype:style=display: flex; height: 230px; align-items: center; justify-content: center; font-size: 38px; -->

Markdown Supports ** Style ** <!-- rehype:style=color: red; -->

Suporte para notas de rodapé da GFM

Here is a simple footnote [ ^ 1 ] . With some additional text after it.

[ ^ 1 ] : My reference.

Ignore a exibição de conteúdo

 # Hello World

<!-- rehype:ignore:start --> Hello World <!-- rehype:ignore:end -->

Good!

Saída:

 < h1 > Hello World </ h1 >

< p > Good! </ p >

Suporte para alertas do GitHub

 import React from 'react' ;
import MarkdownPreview from '@uiw/react-markdown-preview' ;

const source = `> 
> 
> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.


` ;

export default function Demo ( ) {
  return (
    < MarkdownPreview source = { source } style = { { padding : 16 } } />
  )
} 

Apoie o modo escuro/modo noturno

Por padrão, o dark-mode é alterado automaticamente de acordo com o sistema. Se você precisar alternar manualmente, basta definir o parâmetro data-color-mode="dark" para o corpo.

 < html data-color-mode =" dark " > 

 document . documentElement . setAttribute ( 'data-color-mode' , 'dark' )
document . documentElement . setAttribute ( 'data-color-mode' , 'light' )

Herdar variáveis de cores personalizadas adicionando seletor .wmde-markdown-var .

 const Demo = ( ) => {
  return (
    < div >
      < div className = "wmde-markdown-var" > </ div >
      < MarkdownPreview source = "Hello World!" />
    </ div >
  )
}

Defina o tema light .

<MarkdownPreview
  source="Hello World!"
  wrapperElement={{
+    "data-color-mode": "light"
  }}
/>

Desenvolvimento

Executa o projeto no modo de desenvolvimento.

 # Step 1, run first,
# listen to the component compile and output the .js file
# listen for compilation output type .d.ts file
# listen to the component compile and output the .css file
npm run start
# Step 2, development mode, listen to compile preview website instance
npm run doc

Construa o aplicativo para produção na pasta Build.

npm run build

A construção é minificada e os nomes de arquivos incluem os hashes. Seu aplicativo está pronto para ser implantado!

Alternativas

Se você precisar de mais editora de marcação rica em recursos, você pode usar @uiwjs/react-markdown-editor

• @UIW/React-Markdown-Editor: um editor de marcação com visualização, implementado com react.js e TypeScript.
• @uiw/react-md-editor: um editor simples de marcação com visualização, implementado com react.js e datilografript.
• @uiw/react-textaree-code-editor: um editor de código simples com destaque da sintaxe.
• @uiw/react-codemirror: componente codemirror para react. @codemirror
• @uiw/react-monacoeditor: componente do editor de Mônaco para react.

Colaboradores

Como sempre, graças aos nossos incríveis colaboradores!

Feito com contribuidores de ação.

Licença

Licenciado sob a licença do MIT.