https://github.com/importantimport/gumori

📓 Minimal Stylesheets, IndieWeb-Compatible Astro Blog Starter.
https://github.com/importantimport/gumori

astro astrobuild blog blog-template jamstack theme

Last synced: 16 days ago
JSON representation

📓 Minimal Stylesheets, IndieWeb-Compatible Astro Blog Starter.

• Host: GitHub
• URL: https://github.com/importantimport/gumori
• Owner: importantimport
• License: wtfpl
• Created: 2022-05-30T08:14:12.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-25T10:00:58.000Z (over 1 year ago)
• Last Synced: 2025-03-27T04:51:16.573Z (about 1 month ago)
• Topics: astro, astrobuild, blog, blog-template, jamstack, theme
• Language: Astro
• Homepage: https://gumori.netlify.app
• Size: 389 KB
• Stars: 26
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# 📓 Gumori [β]

[![fff](https://img.shields.io/badge/%F0%9F%8C%9F%20F%20F%20F-0.5-yellow?style=flat)](https://fff.js.org)

![language](https://img.shields.io/github/languages/top/importantimport/gumori?color=%23ff5a03)

[![license](https://img.shields.io/github/license/importantimport/gumori?color=%23fff)](COPYING)

> Minimal Stylesheets & IndieWeb-Compatible Astro Blog Starter.

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/importantimport/gumori)

```bash

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](https://github.com/withastro/rfcs/discussions/190))

- [ ] [Types of Posts](https://indieweb.org/posts#Types_of_Posts)

- [ ] Tags

- [x] Multiple Authors

## 🎨 Minimal stylesheets

Gumori only includes styles to go with [rehype-pretty-code](https://github.com/atomiks/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](https://github.com/dbohdan/classless-css#classless) - for example, Gumori currently import [new.css](https://github.com/xz/new.css) by default.

## 🧱 Project Structure

You'll see the following folders and files:

```bash

/

├── 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](https://github.com/importantimport/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](COPYING) file for more details.