Skip to content

Latest commit

 

History

History
96 lines (59 loc) · 3.73 KB

README.md

File metadata and controls

96 lines (59 loc) · 3.73 KB

a tiny, almost-unopinionated Astro starter for your next blog, documentation, personal/marketing website, and more.

it comes with the CUBE CSS file structure, a methodology for managing stylesheets efficiently no matter the size of the project.

the project is mostly barebones, the goal isn't to provide a batteries-included template, just an easy starter kit and stylesheets to copy/paste from.

most styles are for demo purposes and to explain the underlying philosophy: "Be the browser's mentor, not its micromanager" (see buildexcellentwebsit.es).

features

  • CUBE CSS implementation: take a look at the docs, they are concise and explain way better than i would
  • fluid and responsive: it looks great no matter the device size
    • Every Layout examples for layout elements
    • Utopia for fluid clamp()-based font sizes and spacing
  • lightweight: 💯 lighthouse score across the board — not surprising considering the size of the project, but worth mentioning
  • dark-mode ready: implement your own theme switcher if you're into that sort of thing, all you have to do is toggle the data-theme attribute on the body
  • SEO ready: basic SEO meta-tags are set-up, with sitemaps automatically generated at build time

installation

clone this repo

git clone https://github.com/williamhzo/astro-cube.git

instal dependencies

cd astro-cube
npm i

spin up local dev server

npm run dev

build to ./dist/

npm run build

preview production build

npm run preview

...or use the template directly ➡️ "Use this template" > "Create a new repository"

contributions are welcome! 👋

it's great if this kit can be helpful to some folks out there, i'm open to feedback and greatly appreciate contributions, feel free to chip in for fixes, suggestions, or features! let me know if you have improvement ideas.


credits

greater minds than mine are behind the choices in this kit, i'd like to mention them for the inspiration and learning provided:

along with contributors, for a great onboarding experience and a wholesome community.

Andy is a great source of inspiration for building robust UI working with the browser, rather than against it. but also for reminding me that CSS is an extremely powerful tool as it is. CUBE CSS really clicked to me as it brought pure "traditional" CSS to the component-first world of today.

Heydon provides amazing insights and spicy takes on how to build for the web, from an inclusive and accessible perspective.

Lene made an amazing Eleventy starter based on CUBE CSS which is way more mature and complete than this one. it comes batteries included to build a full-blown blog with 11y in a breeze, i'd definitely recommend checking it out.

her starter greatly inspired me to build one for Astro (it will be a separate one from this minimal one).