stonediggity / next-markdown-blog-remote

This is a Next.js project bootstrapped with create-next-app.

Getting Started

Clone repo to local directory. Then you'll need to run below to install all dependencies.

npm install

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Environment Variables

You'll need to create an .env or .env.local file once you have done the above. You'll need a github repo (SEPARATE TO THE REPO YOU HAVE FORKED TO/FROM) with your mdx files (these are the markdown blog files for the site to access)

GITHUB_SECRET = <YOUR_SECRET_HERE>

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Useful project dependencies to learn for future

⚙ Project Dependencies: 🔗 react-icons: https://www.npmjs.com/package/react-i... 🔗 next-mdx-remote: https://www.npmjs.com/package/next-md... 🔗 highlight.js: https://www.npmjs.com/package/highlig... 🔗 rehype-highlight: https://www.npmjs.com/package/rehype-... 🔗 rehype-slug: https://www.npmjs.com/package/rehype-... 🔗 rehype-autolink-headings: https://www.npmjs.com/package/rehype-... 🔗 sharp: https://www.npmjs.com/package/sharp 🔗 next-sitemap: https://www.npmjs.com/package/next-si...