Nanoseconds Produce Minutes
Wondering what’s next for npm?Check out our public roadmap! »

mdx-siteTypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

mdx-site

Static site generator powered by:

lighthouse score

Getting Started

If you're starting from scratch:

  1. mkdir my-site
  2. cd my-site

Within your project, install mdx-site:

  1. `yarn add mdx-site

Now you're ready to run it:

  1. yarn mdx-site
  2. 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

Keywords

none

Install

npm i [email protected]

Version

1.0.0

License

MIT

Unpacked Size

172 kB

Total Files

46

Last publish

Collaborators

  • avatar