Skip to content
Static site generator powered by TypeScript, MDX, & React.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
src
template
types
.gitignore
.nvmrc
.prettierignore
CONTRIBUTING.md
README.md
lighthouse.png
package.json
step-1.png
step-2.png
step-3.png
tsconfig.json
welcome.png
yarn.lock

README.md

mdx  S I T E

Static site generator powered by:

lighthouse score

Getting Started

If you're starting from scratch:

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

Picture of previous steps

Within your project, install mdx-site:

  • yarn add mdx-site

Picture of previous step

Now you're ready to run it:

  • yarn mdx-site

Picture of previous step

Picture of previous step

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

You can’t perform that action at this time.