Giter VIP home page Giter VIP logo

mdx-site's Introduction

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
  3. yarn init -y

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

mdx-site's People

Contributors

ericclemmons avatar bandarudheeraj avatar dependabot[bot] avatar

Forkers

shimedh

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.