From 0d3087088278c86f456754422b67e915536eae5a Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Wed, 16 May 2018 23:25:27 -0600 Subject: [PATCH] Update theme documentation --- docs/Theme Development.md | 146 +++++++++++++++++++++++++++----------- 1 file changed, 105 insertions(+), 41 deletions(-) diff --git a/docs/Theme Development.md b/docs/Theme Development.md index 44bde47..799c8fd 100644 --- a/docs/Theme Development.md +++ b/docs/Theme Development.md @@ -11,11 +11,13 @@ This is the folder structure for a standard theme. The root folder shown below * contact.php * _default.php_ * _404.php_ + * preview.png * ***colors*** * ***default*** * **green** * **etc** - + +If `preview.png` is present, it will be displayed to the user in the theme picker. ## Metadata File @@ -81,9 +83,9 @@ It is highly recommended to have a contact form template included in your theme. Do not use the optional ``, ``, and `` tags for your template HTML. The editor relies on being able to append code to the document and have it still work normally. -Do include FontAwesome 5 in your theme. The SiteWriter editor allows the user to pick icons from the FontAwesome Free icon set to enhance their content. +Do include FontAwesome 5 in your theme. The SiteWriter editor allows the user to pick icons from the FontAwesome Free icon set to enhance their content. Use `get_fontawesome_js()` or `get_fontawesome_css()` instead of including FontAwesome in your theme. It saves space and ensures that all themes have the latest version of FontAwesome. -Do include company info (business name, phone number, address, and email) and social media links (Facebook, Twitter, YouTube, Mastodon, etc) in the theme. These can be setup in the sitewide settings, and users will expect themes to make use of this information. +Do include company info (business name, phone number, address, and email), social media links (Facebook, Twitter, YouTube, Mastodon, etc), and footer links in the theme. These can be setup in the sitewide settings, and users will expect themes to make use of this information. See the Code Snippets section below for examples of this. Do include `` and `` snippets in your templates. They are used to inject additional content into the template, such as third-party analytics code. @@ -110,7 +112,7 @@ Below is a minimal functional `default` template that fulfills the above require <?php get_site_name(); ?> - +