Skip to content

WillKirkmanM/steady

Repository files navigation

Steady

Server Side Generated, MDX written articles created with NextJS 14

Google Lighthouse Report

Getting Started

Install Dependencies:

bun install

Run in Development mode:

bun dev

Build for Production:

bun build

Start Production Build:

bun start

Writing Articles

Articles are written in the content/articles folder. The name of the file before the .mdx will be the url.

In MDX you can set the title and description of the article enclosed by the --- at the top of the file:

---
title: "Hello, World!"
description: "What a day to be alive"
---

Custom Components

If you would like to use Custom Components in your articles, you need to include them in the components/MDX/TheMDXRemote.tsx:

import { Button } from "@/components/ui/button"

const components = {
  Button
}

You can also modify existing behaviour:

  const components = {
    h1: (props) => <h1 className="text-3xl" {...props} />,
    ol: (props: any) => <ol className="list-decimal" {...props} />
  }

then in your article:

Psychologically, the button has to be one of the most appealing elements on the page. Get that wrong and you fail. Take this button for example:

<Button>Login</Button>

Entranced by the look, you find the feel... and click it. Simply perfect

About

🛣 Full Text Searchable SSG NextJS 14 Blog (supporting DOCX and MDX content)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published