Skip to content

Commit 7cfa173

Browse files
[#123] Adding updates to the README
1 parent 6068d6e commit 7cfa173

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

README.dist.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ This will install the WordPress files, composer packages, npm packages, and star
2323

2424
You are all ready to start working on the site.
2525

26+
Information on developing the theme, styling, and building blocks can be found in the theme [README](wp-content/themes/#UPDATETHIS/README.md).
27+
2628
### Build for production
2729
The deploy script should build the files for production, but if you want to test that out on your local server you can change the DDEV config.yaml `ENVIRONMENT` to `prod` and then `cd` into your custom theme folder and run `ddev npm run build`. This will build the JS and CSS files in the dist folder and out put a manifest file.
2830

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ git push -u origin main
5151
```
5252

5353
Be sure to update the origin with the correct remote repository URL (and remove the `<>` brackets).
54+
Information on developing the theme, styling, and building blocks can be found in the theme [README](wp-content/themes/wp-starter/README.md).
5455

5556
# Development
5657

wp-content/themes/wp-starter/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ The `theme.json` holds a lot of the core WordPress theme settings. The `theme.js
1212

1313
Several of the Tailwind variables are pulled in and Tailwind should be used as the primary way to style elements. If you need to, you can pull in more Tailwind variable for custom styling in `theme.json`.
1414

15+
The files that create the `theme.json` can be used to set custom settings for blocks, global theme, or for custom templates. Here are a few references:
16+
- [Global Settings & Styles](https://developer.wordpress.org/block-editor/how-to-guides/themes/global-settings-and-styles/)
17+
- [Theme.json reference](https://developer.wordpress.org/block-editor/reference-guides/theme-json-reference/theme-json-living/)
18+
- [Global Styles & theme.json](https://fullsiteediting.com/lessons/global-styles/)
19+
1520
## Custom Blocks 🧱
1621
Blocks are build using ACF and core WordPress blocks. Styles for the blocks are in `src/styles/blocks`.
1722

@@ -78,6 +83,11 @@ If you have need to apply the buttons style to the mark up you can add one of th
7883
| `.btn-outline-light` |
7984
| `.btn-text` |
8085

86+
#### Adding more Buttons Styles
87+
If you need to add more button styles you can [register](https://developer.wordpress.org/reference/functions/register_block_style/) a new block style on the `core/button`. Once you have the new button style registered you add the Tailwind style in `plugins-tailwind/buttons.js` and assign the class to the button in `/src/styles/core-blocks/buttons.css`. It is recommended that you create descriptive button styles and not generic styles like "primary" or "secondary".
88+
89+
#### Custom Button Icons
90+
The theme has a custom filter to add in custom icons for buttons. You can your custom SVG icons into `/src/images/icons/` and then pull in that SVG icon in `inc/icons.php`. In order for your SVG icon to update with the text you need to set `fill` or `stroke` (depending on your icon) to `currentColor`.
8191

8292
### Navigation
8393
The navigation has been set up to be fully accessible and is built using [Alpine](https://alpinejs.dev/) and the styles are set in CSS. You can edit the JS in `/src/components/dropdown.js` and the CSS in `/src/styles/core-blocks/navigation.css` if you need to customize the navigation.

0 commit comments

Comments
 (0)