Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with changes from UI changes and updated screenshots #571

Merged
merged 4 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 35 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,23 +79,47 @@ Make changes to your site styles, fonts and templates using the Editor.

Still in the WordPress Editor, navigate to the Create Block Theme menu at the top of the Editor.

To simply save recent changes made in the Editor to the currently active theme or export the theme:
To save recent changes made in the Editor to the currently active theme or export the theme:

- Select "Save Changes" to save any recent changes to the currently active theme.
- Select "Export Zip" to export the theme as a zip file.
- Select "Save Changes to Theme" and select any options to customize what is saved
- Check "Save Fonts" to copy the assets for any fonts installed and activated through the Font Library to the active font
- Check "Save Style Changes" to copy your style changes made to the theme.json file
- Check "Save Template Changes" to copy template changes made in the Editor to your activated theme.
- With "Save Template Changes you may also select the following:
- Check "Localize Text" to copy content to patterns from templates so that they can be localized for internationalization.
- Check "Localize Images" to copy any images referenced in templates to the theme asset folder and reference them from a pattern.
- Check "Remove Navigation Refs" to remove any navigation ref IDs from templates.
- Click "Save Changes" to save any recent changes to the currently active theme.

To export your theme to a zip file ready to import into another system:

- Select "Export Zip"

To edit the theme metadata:

- Select "Theme Info" to edit the metadata for the theme. These details will be used in the style.css file.
- Select "Edit Theme Metadata" to edit the metadata for the theme. These details will be used in the style.css file.

To create a new blank theme:

- Select "Create Blank Theme"
- Supply a name for the new theme (and optional additional Metadata)
- Click "Create Blank Theme"

The theme will be created and activated.

To create a variation:

- Select "Create Theme Variation"
- Provide a name for the new Variation
- Click "Create Theme Variation"

A new variation will be created.

To create a new theme, child theme, or style variation, select "Create Theme" to access the following options for the currently active theme:
To create a new Clone of the current theme or to create a Child of the current theme:ons for the currently active theme:
pbking marked this conversation as resolved.
Show resolved Hide resolved

- "Clone Theme" to create a copy of the active theme.
- "Create Child Theme" to create a child theme of the active theme.
- "Create Theme Variation" to create a style variation.
- "Export Theme" to export the theme as a zip file.
- "Export Child Theme" to export a child of the currently active theme as a zip file.
- "Create Blank Theme" to create a new, blank theme with no styles or templates.
- Click "Create Theme"
- Click "Clone Theme" to create a new Theme based on the active theme with your changes
- Click "Create Child Theme" to create a new Child Theme with the active theme as a parent with your changes

To inspect the active theme's theme.json contents:

Expand Down
Binary file modified assets/screenshot-1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshot-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshot-3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshot-4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/screenshot-5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 37 additions & 19 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ This plugin allows you to:
- Create a new theme based on the currently active theme
- Create a child theme of the active parent theme
- Create a new style variation
- Export a theme
- Save user changed templates and styles to the active theme

All newly created themes or style variations will include changes made within the WordPress Editor.

This plugin also makes several changes to the contents of an exported theme, including:
This plugin also makes several changes to the contents of a theme, including:

- Adds all images used in templates to the theme's `assets` folder.
- Ensures the block markup used in templates and patterns is export-ready.
Expand All @@ -42,43 +44,59 @@ Make changes to your site styles, fonts and templates using the Editor.
= Step 3 – Export =
Still in the WordPress Editor, navigate to the Create Block Theme menu at the top of the Editor.

To simply save recent changes made in the Editor to the currently active theme or export the theme:
To save recent changes made in the Editor to the currently active theme
pbking marked this conversation as resolved.
Show resolved Hide resolved

- Select "Save Changes" to save any recent changes to the currently active theme.
- Select "Export Zip" to export the theme as a zip file.

To edit the theme metadata:
2. Create Block Theme save panel in the WordPress Editor

- Select "Theme Info" to edit the metadata for the theme. These details will be used in the style.css file.
To install and uninstall fonts:

2. Theme Info editing panel in the WordPress Editor
- Install and activate a font from any source using the WordPress Font Library.
- Select "Save Changes To Theme" and select "Save Fonts" to save all of the active fonts to the currently active theme. These fonts will then be activated in the theme and deactivated in the system (and may be safely deleted from the system).
- Any fonts that are installed in the theme that have been deactivated with the WordPress Font Library will be removed from the theme.

To create a new theme, child theme, or style variation, select "Create Theme" to access the following options for the currently active theme:
or export the theme:

- Select "Export Zip" to export the theme as a zip file.

To edit the theme metadata:

- "Clone Theme" to create a copy of the active theme.
- "Create Child Theme" to create a child theme of the active theme.
- "Create Theme Variation" to create a style variation.
- "Export Theme" to export the theme as a zip file.
- "Export Child Theme" to export a child of the currently active theme as a zip file.
- "Create Blank Theme" to create a new, blank theme with no styles or templates.
- Select "Edit Theme Metadata" to edit the metadata for the theme. These details will be used in the style.css file.

3. Create Theme panel in the WordPress Editor
3. Theme Metadata editing panel in the WordPress Editor

To inspect the active theme's theme.json contents:

- Select "Inspect Theme JSON"

4. theme.json inspector in the WordPress Editor

To install and uninstall fonts:
To create a new blank theme:

- Install and activate a font from any source using the WordPress Font Library.
- Select "Save Changes" to save all of the active fonts to the currently active theme. These fonts will then be activated in the theme and deactivated in the system (and may be safely deleted from the system).
- Any fonts that are installed in the theme that have been deactivated with the WordPress Font Library will be removed from the theme.
- Select "Create Blank Theme"
- Supply a name for the new theme (and optional additional Metadata)
- Click "Create Blank Theme"

To create a variation:

- Select "Create Theme Variation"
- Provide a name for the new Variation
- Click "Create Theme Variation"

To create a new Clone of the current theme or to create a Child of the current theme:ons for the currently active theme:

- Click "Create Theme"
- Click "Clone Theme" to create a new Theme based on the active theme with your changes
- Click "Create Child Theme" to create a new Child Theme with the active theme as a parent with your changes

5. Create Theme panel 1 in the WordPress Editor

6. Create Theme panel 2 in the WordPress Editor
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this is referencing a new screenshot but I don't see the new screenshot as part of this branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! I'll add them.


Many of these options are also available under the older, deprecated Create Block Theme page under Appearance > Create Block Theme.

5. Page under Appearance > Create Block Theme
7. Page under Appearance > Create Block Theme
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar here - looks like this is a new screenshot but there's no screenshot-7.jpg file.


== Frequently Asked Questions ==

Expand Down
Loading