https://github.com/bonnie/howd-mdx-toc

Code for the Hands-on Web Dev newsletter project to add a Table of Contents to an MDX blog
https://github.com/bonnie/howd-mdx-toc

Last synced: about 1 month ago
JSON representation

Code for the Hands-on Web Dev newsletter project to add a Table of Contents to an MDX blog

• Host: GitHub
• URL: https://github.com/bonnie/howd-mdx-toc
• Owner: bonnie
• Created: 2024-04-17T16:50:36.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-03T20:51:25.000Z (over 1 year ago)
• Last Synced: 2024-10-11T22:55:54.681Z (12 months ago)
• Language: MDX
• Size: 680 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Hands-on Web Dev MDX Table of Contents Workshop

This code supports the MDX Table of Contents Workshop series from the [Hands-on Web Dev newsletter](https://newsletter.howd.dev).

To try the workshop, [start here](https://newsletter.howd.dev/challenges/010/)!

## Getting started

1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) or [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this project.

2. Run `npm install` to install the dependencies

3. Run `npm run dev` to start the dev server

4. Navigate to `localhost:3000` from a web browser

You should see a page that looks like this:

![home page of a blog post, showing a header, footer, and list of posts](./readme-images/scaffolding-home.png)

## This project uses...

- [Next.js](https://nextjs.org/)

- [TypeScript](https://www.typescriptlang.org/)

- [CSS modules](https://github.com/css-modules/css-modules)

- [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote)

- [gray-matter](https://www.npmjs.com/package/gray-matter)

- Josh W. Comeau's [delightful file structure](https://www.joshwcomeau.com/react/file-structure/)