百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
R

remdx

> 编程语言
开源

美观的极简 React 和 MDX 演示

395 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

美观的极简 React 和 MDX 演示

ReMDX

Create beautiful minimalist presentations with React & MDX.

Example Presentations

  • Building Scalable Applications: source code
  • Dev Velocity Presentation: source code
  • Turn Based AI Presentation: source code

Setup

bash
npm init remdx
curl -fsSL https://vite.plus | bash
vp install
vp dev

Custom Setup

See the Example Deck to get started with adding ReMDX to your project:

bash
vp add @nkzw/remdx @nkzw/vite-plugin-remdx

vite.config.ts:

javascript
import { defineConfig } from 'vite-plus';
import remdx from '@nkzw/vite-plugin-remdx';
import react from '@vitejs/plugin-react';

export default defineConfig({
  plugins: [remdx(), react()],
});

index.html:

xml

Then create your slides.re.mdx and start the dev server via vp dev.

Usage

  • Individual slides are separated by three dashes: ---.
  • Front matter blocks can be inserted at the top of a slide and separated from the slide content by two dashes: --. The theme can be set via theme: , and background images can be set via image: , referring to images in the public/ folder.
  • You can export a set of HTML and custom components using export { Components } from './Components'. The Components.tsx file should export an object with component names mapping to their implementation as default export.
  • ReMDX provides a default theme, but you can leave it out and bring your own or customize styles via
  • Code blocks are styled via shiki and support syntax highlighting via CSS variables.
  • The inbuilt image component used for inline images via Markdown syntax (for example: ``) can be styled by passing CSS properties to the query string.
  • If you are using ReMDX for presentations and you like it, please add a slide or note at the end saying "Made with ReMDX". If you can, share the source of your slide deck with the community.

Context & Decisions

Prior Art

ReMDX was inspired by:

  • mdx-deck
  • Spectacle
  • Slidev

The core of ReMDX is a lean fork of Spectacle. create-remdx is based on Slidev. I'd like to thank the authors of the above tools for their awesome work.

Why ReMDX?

All three of the above solutions fall short in some way. Some are a bit outdated, and some have too much cruft or are slow. Slidev is modern but only works with Vue instead of React. I wanted to build a fast MDX-based slide deck tool on top of Vite+ that uses React and only supports a minimal set of features.

ReMDX does not have feature XYZ!

That's not a question. Fork it, build it, and submit a PR.

Opinions

  • Basics: React + Markdown together is a great way to make technical JavaScript presentations.
  • Minimal: ReMDX has few features. If you'd like to add new features, please fork it and consider sending a Pull Request.
  • Composable: ReMDX doesn't box you in. Bring your design system or use Tailwind to lay out your slides.

Issues· 3 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

TypeScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言