Skip to content

PoldarnKJ/poldarn-book

Repository files navigation

Poldarn Book

A minimal blog that just works. No configuration, no social links, no analytics dashboards. Just write markdown, publish, done.

Philosophy: Let it done.

Why Poldarn?

Most blog frameworks ask you to configure:

  • Social media links
  • Analytics tracking
  • Comment systems
  • Newsletter signups
  • SEO metadata
  • ...and 47 other things before you write a single word

Poldarn asks you one thing: Where's your markdown?

1 Minute to Publish

# Clone
git clone https://github.com/poldarn/poldarn-book.git my-blog
cd my-blog

# Write
echo "# Hello World" > content/index.md

# Publish
npm install && npm run build

Deploy the out/ folder anywhere. That's it.

How It Works

content/
├── index.md        → yourblog.com/
├── about.md        → yourblog.com/about
└── posts/
    ├── first.md    → yourblog.com/posts/first
    └── second.md   → yourblog.com/posts/second

Write markdown. Files become pages. Folders become sections.

Features

  • Zero config - No config.yaml, no settings.json, no setup wizard
  • File-based - Your content is just markdown files in a folder
  • Dark mode - Automatic, based on system preference
  • Fast - Static HTML, no JavaScript bloat for reading
  • Clean typography - Optimized for reading, not for showing off

What's NOT Included

Intentionally absent:

  • Social media links
  • Analytics / tracking
  • Comment systems
  • Newsletter forms
  • Share buttons
  • Tags / categories system
  • Search (use Cmd+F)
  • RSS feed generator
  • SEO optimization tools

If you need these, there are excellent frameworks like Hugo, Astro, or Next.js blog templates. Poldarn is for when you just want to write.

Deploy Anywhere

Vercel (easiest)

npx vercel

Netlify

npm run build
# drag & drop the `out/` folder

GitHub Pages

npm run build
# push `out/` to gh-pages branch

Any static host

npm run build
# upload `out/` folder

Customization

Want different colors? Edit app/globals.css. Want a different font? Edit app/layout.tsx.

That's the extent of "configuration" you'll need.

Local Development

npm install
npm run dev

Open localhost:3000. Edit markdown. See changes instantly.

Tech Stack

Next.js, React, TypeScript, Tailwind CSS. But you don't need to know any of that to use it.

Why "Poldarn"?

Named after a character from K.J. Parker's novels - someone who builds things and gets them done without unnecessary complexity.

License

MIT - Do whatever you want with it.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors