🚀10 Trending projects on GitHub for web developers - 21st May 2021 - DEV Community 👩💻👨💻
で紹介されていたDoczというもの。
Docz
Doczは、あなたのコードのための美しいインタラクティブなドキュメントを簡単に書いて公開することができます。コードを紹介するMDXファイルを作成すると、Doczがそれをライブローディング可能な本番用サイトに変換します。
公式
- 特長
- Powered by Gatsby
- Zero config
- Easy to customize
- Based on MDX
- Fully pluggable
- TypeScript support
どうやらまた新たな静的サイトをジェネレートな何かか...と思ったが、既にVersion 2ではあり、過去記事発見。
ただ多少情報更新もありそうなので以下試した流れをメモる。
お試し
npx create-docz-app my-docz-app
で、以下になります。
Success! Created my-docz-app at C:\workspaces\nodejs\docz\my-docz-app
Inside that directory, you can run several commands:
npm run dev
Starts docz in dev mode.
npm run build
Builds the docz app for production.
We suggest that you begin by typing:
cd my-docz-app
npm run dev
npm run dev で http://localhost:3000/ に立ち上がる。
Note that you don't need to follow any file architecture or convention. You can just create your .mdx files and put them anywhere in your project.
DeepL訳: なお、ファイル構成や規約に従う必要はありません。.mdxファイルを作成して、プロジェクトのどこにでも置くことができます。
本当？以下ファイルを適当においてみた。
---
name: Hello world
route: /doc/
---
# こんにちは
Hello, I'm a mdx file!
こんにちは。MDXふぁいるです。
無事できあがった。
netlify にデプロイ
MDX とは
Gatsbyと静的サイトについては
まとめ
ともかく簡単だったのでなにかに使えたらなあというメモでした。
他記事、動画
参考になればさいわいです。