Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
MDX with Next.js
Search
kazuhiro hara
April 24, 2019
Programming
1
330
MDX with Next.js
新進気鋭のドキュメントフォーマット MDX をためす
kazuhiro hara
April 24, 2019
Tweet
Share
More Decks by kazuhiro hara
See All by kazuhiro hara
slow types ってなんだろう?
karad
0
240
ほぼ日のハッカソン Team 1 発表資料
karad
0
53
Dist.43.英語仕事で地味につかうChatGPT 配布版
karad
0
560
VisionOS 向けアプリをつくってみる - よりひろいフロントエンド
karad
0
30
スマートコントラクト入門
karad
0
89
Servo Embed 入門
karad
1
950
PWA checklist app
karad
0
270
Design Trends of Japanese Local Government Websites
karad
0
140
ReactNativeで大規模アプリを作るときに気を付けたいこと
karad
2
800
Other Decks in Programming
See All in Programming
BQで天気基盤をつくって、役立つ情報を可視化してみた!
wakamatsu_takumu
4
640
The Frontend Rubyist
largo
0
470
AFUP Day Lyon 2024 - DDD !== Archi hexagonale
bgalati
0
190
esbuild 最適化芸人
exoego
2
960
Are Your .NET 8 Applications Resilient for the Chaos-proof?
selcukusta
1
210
Using "modern" Ruby to build a better, faster Homebrew
mikemcquaid
3
710
JS RPCを理解する
yusukebe
5
390
의존성 주입과 Dagger Hilt
fornewid
0
110
製造業ドメインにOneTeamでディープ・ダイブする組織設計・組織運営
i_senaz
1
190
EduBlocksでPythonのブロックプログラミング体験!
ueponx
0
170
コンパウンドプロダクト開発の質とスピードを支える Protobuf と Connect #アーキテクチャ_findy / Boosting Compound Product Development Efficiency with Protobuf and Connect
izumin5210
12
640
The Final Frontier of Web Development: React Server Components vs Jakarta EE
ivargrimstad
0
340
Featured
See All Featured
Atom: Resistance is Futile
akmur
260
25k
Robots, Beer and Maslow
schacon
PRO
155
8k
The MySQL Ecosystem @ GitHub 2015
samlambert
244
12k
Teambox: Starting and Learning
jrom
128
8.5k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
188
16k
Why Our Code Smells
bkeepers
PRO
331
56k
The Success of Rails: Ensuring Growth for the Next 100 Years
eileencodes
34
6.1k
Designing with Data
zakiwarfel
96
4.9k
What's new in Ruby 2.0
geeforr
338
31k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
69
14k
Six Lessons from altMBA
skipperchong
22
3.1k
GraphQLの誤解/rethinking-graphql
sonatard
56
9.4k
Transcript
MDX with Next.js MDX を本番環境に導入するまで 2019/04/24 React LT 会
KAZUHIRO HARA @kara_d
https://kansock.industries KAZUHIRO HARA 原 一浩 (@kara_d) ビッグデータの観測・ビジュアライズ および、複雑な
UI デザインがメイン領域
もくじ 1. MDX とは何ですか ? 2. MDX を使うには ?
3. Next.js における導入事例 4. demo : KANSOCK.INDUSTRIES 5. MDX に移行する場合ハマりそうなところ a. front matter を使う b. レイアウトの適用 c. Syntax highlight の適用 d. React コンポーネントをどう書く? 6. MDX は何が変換されるのか ?
MDX とは何ですか ? • MDX ◦ https://mdxjs.com/ ◦ Markdown
for the component era • Markdown 文書に、JSX をシームレスに記述することができるフォーマット形式 ◦ 公開されている React コンポーネントや独自コンポーネントを使うことができる ◦ グラフやリッチコンテンツなど可能性は無限 ! • 拡張子は .mdx ( 設定次第で .md 形式でも使える ) • React やるマンにとっては至福のドキュメント形式 ◦ React やらないマンでも、コンポーネントを使うだけならそこまで専門的な知識は不要
MDX を使うには ? • 公式サイトにて、それぞれのプロダクトへの導入方法が掲載されている ◦ Next.js ◦ Gatsby ◦
Create React App ◦ React static ◦ Webpack ◦ Parcel ◦ X0 • VS Code のプラグインもあるよ ◦ https://marketplace.visualstudio.com/items?itemName=silvenon.mdx
Next.js における導入事例 https://kansock.industries/ では、Next.js を Siatic Site Generator として使っていて、そ の中で
MDX による記述を可能にしている --- title: "全面的に MDX に移行しました" ... --- import { MdxArticle } from '../../../components/layouts/mdxArticle' export default ({ children }) => <MdxArticle>{children}</MdxArticle> # タイトル MDX 表示テストです
demo https://kansock.industries/
MDX に移行する場合ハマりそうなところ • Front matter を使う • レイアウトの適用 • Syntax
highlight の適用 • React コンポーネントをどう書く?
Front matter について Front matter は、ページ固有の情報を記載する変数 next-mdx-frontmatter が便利
--- title: "Example Page" ogp_url: "/ogp_url" --- module.exports = withTypescript( withMdxFm( withSass({ ... })));
レイアウトについて Front matter 的な情報を定義した上で、レイアウトを指定することもできる Markdown は子コンポーネントになる 例えば title や ogp_url
という変数を使える import { MdxArticle } from '../../../components/layouts/mdxArticle' export default ({ children }) => <MdxArticle title={title} date={date} ogp_url={path} ogp_image={ogpImage} ogp_description={ogpDescription} model={this.props.model}>{children}</MdxArticle>
Syntax highlighting について Bulma と Prism が相性悪いので、 highlight.js (rehype-highlight) を使っている
(next.config.js) const rehypeHighlight = require('rehype-highlight'); const withMDX = require('@next/mdx')() const withMdxFm = require('next-mdx-frontmatter')({ MDXOptions: { hastPlugins: [ rehypeHighlight ] } })
MDX で使えるコンポーネント形式 いろいろなスタイルで書ける ( React パッケージは import 済み )
export const TestComponent = function (props) { return (<h1>{props.name} COMPONENT 1</h1>) } export const TestComponent2 = (props) => <h1>{props.name} COMPONENT 2</h1> export class TestComponent3 extends React.Component { render() { return (<h1>{this.props.name} COMPONENT TEST 3</h1>) } }
MDX は何が変換されるのか ? https://mdxjs.com/advanced/ast によれば、以下が AST の Node Type になっている
• jsx (instead of html) • comment (instead of html comments) • import • export
まとめ • MDX を使うと、Markdown に React コンポーネントを書いたり、 定義したりできる • 柔軟なレイアウト、Front
matter、Syntax highlighting もバッチリ • UI スケッチや UI ドキュメントにぜひ!
END KAZUHIRO HARA @kara_d React / React Native /
React 360 / Next.js / MDX でお困りの方、お気軽にご相談ください https://kansock.industries