mdx-site

 ^{S I T E}

Static site generator powered by:

• ʦ TypeScript
• ↓ MDX
• ⚛️ React
• ♻ hot-module-replacement

Getting Started

If you're starting from scratch:

1. mkdir my-site
2. cd my-site
3. yarn init -y

Within your project, install mdx-site:

• yarn add mdx-site

Now you're ready to run it:

• yarn mdx-site

• Visit http://localhost:3000/.

Authoring

1. Add pages to content/:page/index.mdx

2. export data via content/:page/index.tsx

3. Customize HTML template: public/index.html

4. Customize components: components/:tag.tsx

5. 🚀 Publish to dist:

   yarn mdx-site build

All changes are hot-reloaded. Refresh for changes!

Deployment

1. yarn mdx-site build
2. Publish dist as a static site using Netlify, Now, or whatever you'd like.

Author

• Eric Clemmons