README.md

📓 Gumori [β]

Minimal Stylesheets & IndieWeb-Compatible Astro Blog Starter.

npx degit importantimport/gumori my-blog && cd my-blog # create a new project in my-blog
pnpm i # if you don't have pnpm installed, run: npm i -g pnpm

📝 TODO

• JSON Feed (withastro/rfcs#190)
• Types of Posts
• Tags
• Multiple Authors

🎨 Minimal stylesheets

Gumori only includes styles to go with rehype-pretty-code, which means you can use it as the basis for designing your own blog.

If you don't want to write your own styles, you can use the classless CSS library - for example, Gumori currently import new.css by default.

🧱 Project Structure

You'll see the following folders and files:

/
├── gumori/
│   └── elements.md # example.com/elements
├── src/
│   └── gumori.ts # config
└── package.json

Astro looks for .md files in the gumori directory. Each page is exposed as a route based on its filename.

Also you can put any static assets (like images) in the same location!

🖥️ Commands

Command	Action
pnpm i	Installs dependencies
pnpm dev	Starts local dev server at localhost:3000
pnpm build	Build your production site to ./dist/
pnpm preview	Preview your build locally, before deploying

🍴 Variations

The variations of Gumori are listed here, it/they have different features. PR to add yours is also welcome!

• Gumori You - 🖼️ Bringing Material Design 3 to the Astro Blog.

📝 License

This work is free, it comes without any warranty. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.