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 Add "yarn dev" extension Jun 17, 2019
src Add "yarn dev" extension Jun 17, 2019
template
types Working javascript-fatigue example Jun 3, 2019
.gitignore Add working static build! Jun 6, 2019
.nvmrc Working ts-node + hot-module-replacement Jun 2, 2019
.prettierignore Don't prettify tsconfig.json or package.json Jun 9, 2019
README.md Replace step-4 with social card Jun 10, 2019
lighthouse.png Add README.md Jun 6, 2019
package.json Add "yarn dev" extension Jun 17, 2019
step-1.png Add step-by-step images Jun 10, 2019
step-2.png Add step-by-step images Jun 10, 2019
step-3.png Add step-by-step images Jun 10, 2019
tsconfig.json Remove sourceMap Jun 9, 2019
welcome.png
yarn.lock Add np Jun 8, 2019

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.