Skip to content
This repository has been archived by the owner on Feb 15, 2023. It is now read-only.

importantimport/gumori-you

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸ–ΌοΈ Gumori You [WIP]

Bringing Material Design 3 to the Astro Blog.

πŸ‘₯ Contributing

If you're interested in contributing to Gumori You, pls read the following contributing docs before submitting a pull request:

  1. Ask before adding important features.
  2. git messages follow gitmoji and Conventional Commits.
  3. Follow the Material 3 Guidelines wherever possible.

🧱 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

πŸ“ 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.