npm 包 @mdx-js/react 使用教程

什么是 @mdx-js/react?

@mdx-js/react 是一个 npm 包,它允许你使用 markdown 语法编写 React 组件。通俗地说,就是可以在写文章的同时,直接嵌入一些交互式的组件。

举个例子,假设你写了一篇文章介绍 React Hooks:

- ----- ------- -------------------------------------

-------------- ---------------
-------- ------------------ -
  ----- ------- --------- - ------------

  ------ -
    -----
      ------ ------- ------- ---------
      ------- ----------- -- -------------- - ----
        ----- ---
      ---------
    ------
  --
-
----------------

---------------------- ----- --------------

在上面的例子中,<CodeHighlight> 是一个自定义的组件,用来显示代码高亮。但是,如果我们想让这个组件更加交互式,例如可以直接通过组件来修改代码,那该怎么办呢?

这时候,@mdx-js/react 就派上用场了。通过它,我们可以将上面的代码片段改写成这样:

------ - -------- - ---- --------
------ - ------------- - ---- ------------------

-- - ----- ------- -------------------------------------

-------------- -------------- ---------
--
-------- ------------------ -
  ----- ------- --------- - ------------

  ------ -
    -----
      ------ ------- ------- ---------
      ------- ----------- -- -------------- - ----
        ----- ---
      ---------
    ------
  --
---
----------------

---------------------- ----- --------------

这里有两个变化。首先,我们引入了 useState,以便在代码片段中使用。其次,我们给 CodeHighlight 添加了一个 editable 属性,使它变得更加交互式。

如何使用 @mdx-js/react?

上面的例子只是一个小小的介绍。如果你想使用 @mdx-js/react 来写一篇完整的文章,该怎么办?

首先,你需要安装 @mdx-js/react 和其他相关依赖:

--- ------- ------ ------------- ----------- ----------------

接着,在你的代码中使用 MDXProvider

------ ----- ---- --------
------ - ----------- - ---- ----------------
------ - ------ - ---- ------------
------ --------- ---- ------------------

----- ---------- - -
  --- ----- -- --- -------- ------ -------- -- ---------- --
  -- --- -------
--

-------
  ------------ ------------------------
    ---------- --
  ---------------
  --------------------------------
--

这里,我们将 MyArticle 作为一个组件来渲染。MDXProvider 允许我们自定义组件的渲染方式,例如对于每个 h1,我们可以设置它的样式为红色。

最后,创建 MyArticle.mdx 文件,开始你的写作:

- ----- ---- --

------- ------------ ------ ---- ---

-- --- ------

---- ------

-- ---- ------

--------

-------------- ---------------
-------- ------------------ -
  ------ --------- ------------------
-

------------ ------------ --
----------------

---------------- ----- -----------------

如果你运行这个 demo,你会发现页面上显示了一篇个性化的 markdown 排版的文章。当然,如果你希望更进一步,例如添加自定义组件或者样式等,都可以通过 MDXProvider 来实现。

总结

本文介绍了如何使用 @mdx-js/react 来编写交互式的 markdown 文章。如果你想将你的文章变得更有趣,加入一些交互式的组件,那 @mdx-js/react 可以省下你不少时间。当然,学习这个库也需要一定的时间和精力,但我相信它会对你有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/mdx-js-react


猜你喜欢

  • npm 包 @beisen-cmps/italent-feed-8 的使用教程

    前言 @beisen-cmps/italent-feed-8 是领英中国公司出品的一款前端组件库,其所包含的 italent-feed-8 组件主要用于显示人才推荐、招聘职位等内容。

    4 年前
  • npm 包 @beisen-cmps/italent-feed-7 使用教程

    @beisen-cmps/italent-feed-7 是一款前端开发中非常实用的 npm 包,旨在为用户提供一种方便、快捷的方式获取人才库中的相关信息。本文将介绍该 npm 包的使用教程,包括安装、...

    4 年前
  • npm 包 @beisen-cmps/italent-feed-4 使用教程

    前言 随着前端技术的发展和普及,我们已经不再限制于使用常规的 jQuery 和 JavaScript,而是可以使用各种优秀的 npm 包来解决我们的前端需求。 其中,@beisen-cmps/ital...

    4 年前
  • npm 包 ux-m-platform-modal 使用教程

    在前端开发中,模态框是一个非常常见的 UI 组件,可以用来展示弹出的信息、与用户进行交互等。为了方便开发者快速构建高质量的模态框组件,ux-m-platform-modal 这个 npm 包应运而生。

    4 年前
  • npm 包 rc-cropping 使用教程

    在前端开发中,处理图片是一个非常常见的需求。而一款实用的图片裁剪工具,可以提高我们的工作效率和用户体验。npm 包 rc-cropping 就是这样一款非常实用的图片裁剪工具。

    4 年前
  • npm 包 @beisen-platform/target-pop 使用教程

    @beisen-platform/target-pop 是一款前端 UI 组件,通过在页面上动态生成弹框,实现弹框提示功能。它提供了多种类型的弹框样式,并支持弹框内容自定义。

    4 年前
  • npm 包 shineout 使用教程

    什么是 shineout? shineout 是一个基于 React 的 UI 组件库,提供了一系列高质量的组件,包括按钮、表单、表格等等。它提供了丰富的主题配置,可以根据不同的项目需求,选择不同的主...

    4 年前
  • npm 包 italent-subordinate-tree 使用教程

    前言 italent-subordinate-tree 是一款 NPM 包,它提供了一种将员工关系树形化的解决方案。使用该包可以将员工之间的主管下属关系转化为树形结构进行展示,方便用户快速了解团队内部...

    4 年前
  • NPM 包 italent-share-box 使用教程

    什么是 italent-share-box? italent-share-box 是一个基于 React 的社交分享组件库。它提供了包括微信、QQ、微博、Facebook、Twitter 在内的多种社...

    4 年前
  • npm包@reacted/use-ajax-upload使用教程

    @reacted/use-ajax-upload 是一个 React Hooks 插件,可以轻松实现 AJAX 文件上传的功能。此插件使用简单,可以使用无需获取过多的 AJAX 细节,最适合初学者。

    4 年前
  • npm包@beisen/um-rich-editor使用教程

    前言 在前端开发中,富文本编辑器是大家经常使用的一个工具,它既方便了用户输入,又能让网页内容更加生动有趣。今天,我们来介绍一款基于UMEDITOR的富文本编辑器插件@beisen/um-rich-ed...

    4 年前
  • npm 包 @beisen/timeline-wrapper 使用教程

    前言 @beisen/timeline-wrapper 是一个以 Ant Design Timeline 为基础组件封装的,适用于非静态简单时间线的 React 组件。

    4 年前
  • npm 包 @beisen/ocean-tree 使用教程

    前言 在前端开发中,树形控件是非常常见的 UI 组件,可以用于展示层级关系、目录结构等。在实现树形控件时,我们通常需要考虑如何组织数据、如何渲染节点等问题。这时,npm 包 @beisen/ocean...

    4 年前
  • npm 包 @beisen/day-picker 使用教程

    什么是 @beisen/day-picker @beisen/day-picker 是一个基于 React 的日期选择组件,提供了丰富的日期选择功能。这个组件帮助开发者快速、方便地选择日期,同时也能够...

    4 年前
  • npm 包 @beisen-cmps/italent-feedlist-wrapper 使用教程

    在前端开发中,开发者需要使用不同的工具和技术来完成任务。其中,使用 npm 包是一种常见的方式,可以加快开发速度并提高开发效率。本文将介绍 npm 包 @beisen-cmps/italent-fee...

    4 年前
  • npm 包 @beisen-cmps/italent-feed-container 使用教程

    前言 在前端开发中,我们经常需要展示数据列表,而一个好的列表容器能够让我们的开发效率更高,让我们的前端页面看起来更加美观,在这篇文章中,我们将会讲解如何使用 npm 包 @beisen-cmps/it...

    4 年前
  • npm 包 react-scrollbar 使用教程

    简介 React Scrollbar 是一个基于 React 的滚动条组件,使用方便,具有高度的自定义性和可扩展性。在本文中,我们将学习如何使用 React Scrollbar 包,包括安装、配置和使...

    4 年前
  • npm 包 italent-icon 使用教程

    前言 在前端开发中,我们经常需要使用各种图标来设计网站或应用程序。为了便于使用,有很多现代化的方式来获取图标。其中,一种流行的方式是使用 npm 包。 在本文中,我们将介绍如何使用 npm 包 ita...

    4 年前
  • npm 包 @beisen/talentjs-ui 使用教程

    在前端开发中,我们经常使用各种第三方库来提高开发效率和代码质量。@beisen/talentjs-ui 是一个针对人才招聘领域开发的 UI 组件库,提供了丰富的组件和样式,能够方便快捷地构建招聘网站的...

    4 年前
  • npm 包 @beisen/user-selector 使用教程

    在前端开发过程中,用户选择器是很常用的一个组件。@beisen/user-selector 是一款方便易用的用户选择器组件,支持多选/单选,提供搜索功能,同时还支持自定义页面。

    4 年前

相关推荐

    暂无文章