Skip to content

Commit

Permalink
Update readme, remove test files from release build (#548)
Browse files Browse the repository at this point in the history
* Update readme, removing reference to fonts

* Remove from readme.md

* Remove test-related files from release build

* Update README.md

Co-authored-by: Sarah Norris <1645628+mikachan@users.noreply.github.com>

* Update README.md

Co-authored-by: Sarah Norris <1645628+mikachan@users.noreply.github.com>

* Update README.md

Co-authored-by: Sarah Norris <1645628+mikachan@users.noreply.github.com>

---------

Co-authored-by: Sarah Norris <1645628+mikachan@users.noreply.github.com>
  • Loading branch information
vcanales and mikachan committed Apr 9, 2024
1 parent 8a28063 commit c6492f7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 22 deletions.
5 changes: 4 additions & 1 deletion .distignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,8 @@ babel.config.js
composer.json
composer.lock
package-lock.json
phpcs.xml.dist
webpack.config.js
.phpcs.xml.dist
phpunit.xml.dist
tests/
bin/
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ This plugin allows you to:

- Export your existing theme with all customizations made in the Site Editor
- Create a new theme, blank theme, child theme, or style variation from the Site Editor
- Embed Google Fonts locally in your theme
- Embed local font assets in your theme

Learn more about Create Block Theme:

Expand Down Expand Up @@ -55,30 +53,21 @@ Saves user's changes as a [style variation](https://developer.wordpress.org/them

### Embed Google Fonts or local font files

This feature allows you to embed fonts into your active theme. You can embed Google Fonts and local font assets.

When you add a font the plugin will add to your theme:

- The font files to your theme's file structure under this path `./assets/fonts`.
- The font face definitions to the `theme.json` file.

You can continue using your modified theme or you can export it as a new theme containing the new fonts.
**DEPRECATED:** Fonts can now be managed using WordPress' native Font Library. [More information](https://wordpress.org/documentation/wordpress-version/version-6-5/#add-and-manage-fonts-across-your-site).

## How to Use the Plugin

### Step 1: Setup

To use the latest release of the Create Block Theme plugin on your WordPress site: install from the plugins page in wp-admin, or [download from the WordPress.org plugins repository](https://wordpress.org/plugins/create-block-theme).

In the WordPress Admin Dashboard, under Appearance there will be three new pages called:
In the WordPress Admin Dashboard, under Appearance there will be a new page called:

- Create Block Theme
- Embed Google font in your active theme
- Embed local font file assets

### Step 2: Fonts, styles and templates customizations
### Step 2: Styles and templates customizations

Make changes to your site styles and templates using the Site Editor. You can also include new fonts using the plugin options.
Make changes to your site styles and templates using the Site Editor.

### Step 3: Save

Expand Down
8 changes: 2 additions & 6 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,18 @@ A WordPress plugin to create block themes.
This plugin allows you to:

- Create a new theme, blank theme, child theme or style variation.
- List and preview font families and font faces embeded in your theme.
- Embed Google Fonts in your theme.
- Embed local font assets in your theme.

The plugin is development only — not intended for use on production websites, but used as a tool to create new themes.

= Step 1 – Setup =
Install and activate the [Create Block Theme](https://wordpress.org/plugins/create-block-theme) plugin.

In the WordPress Admin Dashboard, under Appearance there will be three new pages called:
In the WordPress Admin Dashboard, under Appearance there will be a new page called:

- Create Block Theme
- Manage fonts

= Step 2 – Style Customizations =
Make changes to your site styles and templates using the Site Editor. You can also include new fonts using the plugin options.
Make changes to your site styles and templates using the Site Editor.

= Step 3 – Export =
Still in the WordPress dashboard, navigate to "Appearance" -> "Create Block Theme" section. Select one of the available options and then, if necessary, add the details for the theme here. These details will be used in the style.css file. Click "Generate” button, to save the theme.
Expand Down

0 comments on commit c6492f7

Please sign in to comment.