WordPress/create-block-theme
1
0
Fork 0
mirror of https://github.com/WordPress/create-block-theme.git synced 2025-10-03 16:11:13 +08:00
Code Issues Projects Packages Wiki Activity Actions
A WordPress plugin to create block themes https://wordpress.org/plugins/create-block-theme/
359 commits 11 branches 61 tags 67 MiB
Find a file
Sarah Norris ee7ff2bea2 Add commit hook
2023-02-01 10:58:44 +00:00
.github/workflows using auto generated release notes 2023-01-24 11:39:55 +08:00
.husky Add commit hook 2023-02-01 10:58:44 +00:00
.wordpress-org moving assets files 2022-10-26 16:13:11 -03:00
admin Fix new lines at end of files 2023-02-01 10:19:13 +00:00
assets Updating file 2023-01-31 00:12:38 +00:00
css Fix new lines at end of files 2023-02-01 10:19:13 +00:00
includes Fix new lines at end of files 2023-02-01 10:19:13 +00:00
src Fix new lines at end of files 2023-02-01 10:19:13 +00:00
.browserslistrc Add browserlist config 2023-02-01 10:45:13 +00:00
.distignore moving assets files 2022-10-26 16:13:11 -03:00
.editorconfig Add browserlist config 2023-02-01 10:45:13 +00:00
.eslintignore Add browserlist config 2023-02-01 10:45:13 +00:00
.gitignore Add new dependencies 2023-01-27 16:53:29 +00:00
.nvmrc Specify node and npm versions, add nvmrc file 2023-01-19 18:04:58 +08:00
.phpcs.xml.dist Add new dependencies 2023-01-27 16:53:29 +00:00
.prettierignore Add prettier and stylelint config files 2023-02-01 10:39:16 +00:00
.prettierrc.js Add prettier and stylelint config files 2023-02-01 10:39:16 +00:00
.stylelintignore Add prettier and stylelint config files 2023-02-01 10:39:16 +00:00
.stylelintrc.json Add prettier and stylelint config files 2023-02-01 10:39:16 +00:00
babel.config.js Update babel settings 2023-02-01 10:39:42 +00:00
composer.json Use Gutenberg composer setup 2023-01-30 18:48:20 +00:00
composer.lock Use Gutenberg composer setup 2023-01-30 18:48:20 +00:00
create-block-theme.php Version bump & changelog update 2023-01-31 05:25:48 +00:00
index.php Results of lint:php:fix 2023-01-27 17:27:18 +00:00
LICENSE Initial commit 2021-10-29 13:39:09 +01:00
package-lock.json Add commit hook 2023-02-01 10:58:44 +00:00
package.json Add commit hook 2023-02-01 10:58:44 +00:00
README.md Replace current theme with active theme or currently active theme 2022-12-18 23:06:45 +01:00
readme.txt Version bump & changelog update 2023-01-31 05:25:48 +00:00
update-google-fonts-json-file.js Revert formatting changes 2023-02-01 10:16:03 +00:00
update-version-and-changelog.js Try empty line again... 2023-02-01 10:21:29 +00:00

README.md

Create Block Theme

A WordPress plugin to create block themes.

This plugin allows you to:

  • Create a new theme, blank theme, child theme or style variation.
  • 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.

Create Block Theme

This feature can be used in six ways:

1.Export

Export the activated theme including the user changes.

2. Create a child theme

Creates a new child theme with the currently active theme as a parent.

3. Clone the active theme

Creates a new theme by cloning the activated theme. The resulting theme will have all of the assets of the activated theme combined with the user's changes.

4. Overwrite theme files

Saves user's changes to the theme files and deletes the user's changes.

5. Generate blank theme

Generate a boilerplate "empty" theme inside of current site's themes directory.

6. Create a style variation

Saves user's changes as a style variation of the currently active theme.

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.

How to use the plugin

Step 1 – Setup

Install and activate the Create Block Theme plugin.

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

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

Step 2 – Fonts, 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.

Step 3 – Save

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.