Главная страница>Ресурсы для создания веб-сайтов>Другие ресурсы
Скачать

React Markdown Preview

React Component Preview Text Text в веб -браузере. Минимальное количество CSS для воспроизведения стиля отметки GitHub. Текущий веб -сайт документа преобразуется с использованием этого компонента React.

Функции

  • ? Поддержка темного режима/ночного режима. @v4
  • ? ??
  • ??
  • ? Поддержка автоматического блока кода.
  • ? Поддержка определения стилей с помощью комментариев.
  • ⛳ Поддержка сноски GFM
  • ⛳ Поддержка оповещения GitHub

Быстрый старт 

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

Пример использования 

 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 } } />
  )
}

Отключить ссылки на заголовок 

 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 )
        }
      } }
    />
  ) ;
}

Выделите линию

Синтаксис: ```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 )
        }
      } }
    />
  ) ;
}

Показать номера строк

Синтаксис: ```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 )
        }
      } }
    />
  ) ;
}

Код выделения 

 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 } } />
  ) ;
}

Удалить выделение кода

Следующий пример может помочь вам исключить код, выделяющий код из включения в пакет. @uiw/react-markdown-preview/nohighlight Component не содержит пакет подчеркивания кода rehype-prism-plus , showLineNumbers и функции highlight line больше не будут работать. (#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 )
        }
      } }
    />
  ) ;
}

Игнорировать

Игнорируйте отображение контента с помощью HTML -комментариев, показанных в GitHub Readme, исключенном в 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 -->

Поддержать пользовательский предварительный просмотр Katex

Katex-быстрая, простой в использовании библиотеки JavaScript для математического визуализации Tex в Интернете, мы выполняем математическую рендеринг через 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 > ;
        } ,
      } }
    />
  ) ;
}

Поддержать предварительный просмотр пользовательской русалки

Использование русалки для генерации диаграммы и блок -схемы из текста аналогично отмечению. 

 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
      } }
    />
  ) ;
}

Безопасность

Обратите внимание, что Маркдаун должен быть дезинфицирован, если вы не полностью доверяете своим авторам. В противном случае ваше приложение уязвимо для XSS. Это может быть достигнуто, добавив Rehype-Sanitize в качестве плагина. 

 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 } } />
  )
}

Опции реквизит 

 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 , Default: '' )
    Отметка в Parse
  • className ( string? )
    Оберните отметки в div с этим именем класса

Это ReactMarkdownProps подробно. Обновление react-markdown v9

  • children ( string , по умолчанию: '' )
    Отметка в Parse
  • className ( string? )
    Оберните отметки в div с этим именем класса
  • skipHtml ( boolean , по умолчанию: false -> true )
    Полностью игнорируйте HTML в размере
  • allowElement ( (element, index, parent) => boolean? Необязательно)
    Функция вызвана, чтобы проверить, разрешен ли элемент (когда правда) или нет. allowedElements / disallowedElements используется в первую очередь!
  • remarkPlugins ( Array.<Plugin> , по умолчанию: [] )
    Список плагинов замечания для использования. См. Следующий раздел для примеров, как пройти варианты
  • rehypePlugins ( Array.<Plugin> , по умолчанию: [] )
    Список плагинов Rehype для использования. См. Следующий раздел для примеров, как пройти варианты

Примечание

Обновление react-markdown V8 В V9

Добавить urlTransform

transformImageUri и transformLinkUri были удалены. Наличие двух функций - это немного, особенно потому, что есть больше URL -адресов, которые вы можете изменить (или что может быть небезопасно, поэтому мы сделаем их в безопасности). И их имя и API были немного странными. Вместо этого вы можете использовать новую опору urlTransform , чтобы изменить все ваши URL -адреса.

Удалить linkTarget

Опция linkTarget была удалена; Вы, вероятно, не должны устанавливать цели. Если вы хотите, используйте rehype-external-links .

Удалить includeElementIndex

Опция includeElementIndex была удалена, поэтому index никогда не передается компонентам. Напишите плагин, чтобы пройти index :

Показать пример плагина 
 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
      }
    } )
  }
}

Удалить rawSourcePos

Опция rawSourcePos была удалена, поэтому sourcePos никогда не передается компонентам. Все компоненты проходят node , так что вы можете получить node.position от них.

Удалить sourcePos

Опция sourcePos была удалена, поэтому data-sourcepos никогда не передается элементам. Напишите плагин, чтобы пройти index :

Показать пример плагина 
 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 )
      }
    } )
  }
}

Удалить дополнительные реквизиты, переданные в определенные компоненты

При перезаписи компонентов эти реквизиты больше не проходят:

  • inline на code - создайте плагин или используйте pre для блока
  • level на h1 , h2 , h3 , h4 , h5 , h6 - Check node.tagName вместо этого
  • checked на li -Проверьте класс task-list-item или проверьте props.children
  • index на li - создайте плагин
  • ordered на li - создайте плагин или проверьте родитель
  • depth на ol , ul - создайте плагин
  • ordered на ol , ul - Проверьте node.tagName вместо этого
  • isHeader на td , th - проверьте node.tagName вместо этого
  • isHeader на tr - создайте плагин или проверьте детей

Особенности разметки

Поддержка для стиля CSS

Используйте HTML Comments <!--rehype:xxx--> чтобы позволить настройке стиля поддержки Markdown. 

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

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

Поддержка сноски GFM 

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

[ ^ 1 ] : My reference.

Игнорировать дисплей содержимого 

 # Hello World

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

Good!

Выход: 

 < h1 > Hello World </ h1 >

< p > Good! </ p >

Поддержка оповещений 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 } } />
  )
}

Поддержка темного режима/ночного режима

По умолчанию dark-mode автоматически переключается в соответствии с системой. Если вам нужно переключиться вручную, просто установите параметр data-color-mode="dark" для тела. 

 < html data-color-mode =" dark " > 
 document . documentElement . setAttribute ( 'data-color-mode' , 'dark' )
document . documentElement . setAttribute ( 'data-color-mode' , 'light' )

Унаследовать пользовательские цветовые переменные, добавив селектор .wmde-markdown-var . 

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

Установите тему light . 

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

Разработка

Запускает проект в режиме разработки. 

 # 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

Создает приложение для производства в папку сборки. 

npm run build

Сборка занижена, а имена файлов включают хэши. Ваше приложение готово к развертыванию!

Альтернативы

Если вам нужно больше, богатый функциями редактор Markdown, вы можете использовать @Uiwjs/React-Markdown-Editor

  • @UIW/React-Markdown-Editor: редактор Markdown с предварительным просмотром, реализованный с React.js и TypeScript.
  • @UIW/React-MD-Editor: простой редактор Markdown с предварительным просмотром, реализованный с React.js и TypeScript.
  • @UIW/React-Textarea-Code-Editor: простой редактор кода с синтаксисом.
  • @UIW/React-Codemirror: Компонент Codemirror для React. @codemirror
  • @UIW/React-Monacoeditor: Monaco Editor Component для React.

Участники

Как всегда, благодаря нашим удивительным участникам!

Сделано с контрольными действиями.

Лицензия

Лицензирован по лицензии MIT.

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все