themes-wordpress/seedlet/README.md

56 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2020-06-10 16:58:55 +00:00
# Seedlet
Seedlet is simple, text-driven WordPress theme.
2020-06-10 16:58:55 +00:00
![](https://github.com/Automattic/themes/raw/master/seedlet/screenshot.png)
2020-06-10 16:58:55 +00:00
Along with being an excellent standalone theme, Seedlet is designed to be a parent-theme that allows folks to quickly create Gutenberg-ready child-themes for WordPress. *[Instructions for how to make child themes are coming soon]*
2020-06-10 16:58:55 +00:00
## Development
2020-06-10 16:58:55 +00:00
To make changes to the styles, [node.js](https://nodejs.org/en/) is recommended:
2020-06-10 16:58:55 +00:00
1. `npm i` to install the required development dependencies
2. `npm start` to start the development server
3. Make changes in `assets/sass`
2020-06-10 16:58:55 +00:00
## Technical Overview
2020-06-10 16:58:55 +00:00
### Principles
2020-06-10 16:58:55 +00:00
When you reduce a theme design down to a set of systematic design decisions, you end up with something called a _Style Guide_. The Seedlet system works by taking the rules of a Style Guide and expressing them through carefully placed variables or _design tokens_ that influence the appearance of a WordPress site.
2020-06-10 16:58:55 +00:00
This unifies the design decisions needed to style the aesthetic appearance of Gutenberg Blocks, the theme Header + Footer areas, WooCommerce, Jetpack and more. It also syncs styles between the editor and the frontend so that you dont need to hand-write CSS for both. This greatly speeds up the Gutenberg theme development process and reduces the amount of manual styling that typically goes into developing a theme.
2020-06-10 16:58:55 +00:00
### Controls
2020-06-10 16:58:55 +00:00
The theme is built to offer the following controls:
2020-06-10 16:58:55 +00:00
- **Fonts** - Font-family, size, weight, and line-height rules.
- **Colors** - Primary, secondary, background, foreground and border colors.
- **Spacing** - A default 8px vertical rhythm between all blocks and major components. It also includes utility spacing classes for negative margins.
- **Responsive Logic** - Built-in responsive behavior across Blocks and Components.
2020-06-10 16:58:55 +00:00
### Structure
2020-06-10 16:58:55 +00:00
The system itself lives in the `/assets/sass` directory as a collection of Sass partials broken up by scope and hierarchy. The partials get compiled down to singular CSS files that live in the main Seedlet directory and cascade downward like so:
2020-06-10 16:58:55 +00:00
**Frontend**
- `/assets/css/variables.css`
- `/style.css`
2020-06-10 16:58:55 +00:00
**Editor**
- `/assets/css/variables-editor.css`
- `/style-editor.css`
2020-06-10 16:58:55 +00:00
In each view, the variables are loaded first and then the stylesheet is loaded which applies the variables.
2020-06-10 16:58:55 +00:00
## License
2020-06-10 16:58:55 +00:00
GNU General Public License v2 or later.
2020-06-10 16:58:55 +00:00
URI: [LICENSE](https://github.com/Automattic/themes/blob/master/seedlet/LICENSE)
## Acknowledgments
CSS vars ponyfill: https://github.com/jhildenbiddle/css-vars-ponyfill