https://github.com/ericclemmons/mdx-site

Static site generator powered by TypeScript, MDX, & React.
https://github.com/ericclemmons/mdx-site

markdown mdx now react tailwindcss typescript

Last synced: about 1 month ago
JSON representation

Static site generator powered by TypeScript, MDX, & React.

• Host: GitHub
• URL: https://github.com/ericclemmons/mdx-site
• Owner: ericclemmons
• Created: 2019-05-26T22:58:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T22:43:11.000Z (almost 2 years ago)
• Last Synced: 2024-09-26T18:21:43.375Z (about 2 months ago)
• Topics: markdown, mdx, now, react, tailwindcss, typescript
• Language: TypeScript
• Homepage:
• Size: 2.71 MB
• Stars: 51
• Watchers: 3
• Forks: 3
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome - mdx-site - Static site generator powered by TypeScript, MDX, & React. (TypeScript)

README

        


  

   S I T E



Static site generator powered by:

- `ʦ` [TypeScript][ts]

- `↓` [MDX][mdx]

- `⚛`️ [React][react]

- `♻` [hot-module-replacement][hmr]

![lighthouse score](lighthouse.png)

## Getting Started

If you're starting from scratch:

1. `mkdir my-site`

1. `cd my-site`

1. `yarn init -y`

![Picture of previous steps](step-1.png)

Within your project, install `mdx-site`:

- `yarn add mdx-site`

![Picture of previous step](step-2.png)

Now you're ready to run it:

- `yarn mdx-site`

![Picture of previous step](step-3.png)

- Visit .

![Picture of previous step](welcome.png)

## Authoring

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

1. `export` data via `content/:page/index.tsx`

1. Customize HTML template: `public/index.html`

1. Customize components: `components/:tag.tsx`

1. 🚀 Publish to `dist`:

   `yarn mdx-site build`

**All changes are [hot-reloaded][hmr]**. Refresh for changes!

## Deployment

1. `yarn mdx-site build`

1. Publish `dist` as a static site using Netlify, Now, or whatever you'd like.

## Author

- [Eric Clemmons](ericclemmons.com)

[hmr]: https://github.com/sidorares/hot-module-replacement

[mdx]: https://mdxjs.com/

[now]: https://zeit.co/now

[react]: https://reactjs.org/

[site]: https://ericclemmons.com/

[ts]: https://www.typescriptlang.org/