#1 Add additional detail to README files

Update starter_theme name to source_theme_name
Bixal · Dec 14, 2024 · 7ae25c9 · 7ae25c9
1 parent bab3785
commit 7ae25c9
Show file tree

Hide file tree

Showing 24 changed files with 66 additions and 58 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,7 @@
 version: 2
 updates:
   - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/starter_theme/" # Location of package manifests
+    directory: "/source_theme_name/" # Location of package manifests
     schedule:
       interval: "weekly"
     labels:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,18 +10,14 @@
 ### Initialize child theme using drupal theme generate function
 
 Determine what theme machine name you want to use in this example we are using `my_new_theme`.
-First create a `custom` directory in `themes` directory if there isn't one: `mkdir web/themes/custom`.
 
 ```
-lando php web/core/scripts/drupal generate-theme --starterkit starter_theme my_new_theme --path themes/custom
-lando drush cr
-```
-
-### Remove these lines from your custom theme .info.yml file
+# First create a `custom` directory in `themes` directory.
+mkdir -p web/themes/custom
 
-```
-hidden: true
-starterkit: true
+# Generate the theme using Drupal's built in theme generation and starterkit from Bixal USWDS theme.
+lando php web/core/scripts/drupal generate-theme --starterkit source_theme_name my_new_theme --path themes/custom
+lando drush cr
 ```
 
 ### Install and set your custom theme as the default

diff --git a/README.md b/README.md
@@ -1,9 +1,12 @@
 # Bixal USWDS Drupal base theme
 
-@TODO document the process to create a new child theme from the starter_theme.
+## Introduction
+Bixal's USWDS Drupal base theme is expected to be installed and not modified in a project. It includes a baseline of functions, configuration and templates for new projects. The base theme also includes a starterkit for generating a custom theme per project.
 
-## Install base theme by modifying composer.json file
-Add bixal/bixaluswds to `repositories` object.
+**\*\*WARNING!\*\*: DO NOT clone** this theme into your project codebase! If you plan to contribute follow the instructions instead written in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## 1. Install base theme by modifying composer.json file.
+To configure the installation of the base theme in the contrib themes directory add bixal/bixaluswds to `repositories` object in `composer.json`.
 ```
 {
     "type": "package",
@@ -19,17 +22,21 @@ Add bixal/bixaluswds to `repositories` object.
     }
 }
 ```
-Then run
+Then run this to install.
 ```
 lando composer require "bixal/bixaluswds"
 ```
 
-## Initialize child theme using drupal theme generate function
-Determine what theme name you want to use in this example we are using `my_new_theme`.
-First create a `custom` directory in `themes` directory if there isn't one `mkdir web/themes/custom`.
+## 2. Initialize child theme using drupal theme generate function.
+Determine what theme name you want to use. In this example we are using `my_new_theme`.
 ```
-lando php web/core/scripts/drupal generate-theme --starterkit starter_theme my_new_theme --path themes/custom
+# First create a `custom` directory in `themes` directory.
+mkdir -p web/themes/custom
+
+# Generate the theme using Drupal's built in theme generation and starterkit from Bixal USWDS theme.
+lando php web/core/scripts/drupal generate-theme --starterkit source_theme_name my_new_theme --path themes/custom
 lando drush cr
 ```
 
-## Install the theme dependencies and set your custom theme as the default
+## 3. Install the theme dependencies and set your custom theme as the default.
+Follow instructions found in your new theme's README file to install dependencies and set your theme as the default.
diff --git a/starter_theme/.gitignore → source_theme_name/.gitignore b/starter_theme/.gitignore → source_theme_name/.gitignore
diff --git a/starter_theme/.nvmrc → source_theme_name/.nvmrc b/starter_theme/.nvmrc → source_theme_name/.nvmrc
diff --git a/starter_theme/README.md → source_theme_name/README.md b/starter_theme/README.md → source_theme_name/README.md
@@ -1,16 +1,20 @@
 # Bixal USWDS Drupal theme
 
-@TODO Modify this starter_theme to work with core function to generate theme
-https://www.drupal.org/docs/core-modules-and-themes/core-themes/starterkit-theme#s-custom-starterkit-theme
-
 ## Requirements
 
 Node: https://nodejs.org/en/
 NVM: https://github.com/nvm-sh/nvm
 
 ## Getting started
 
-### Installing the node package dependencies and running a build
+### Was this theme just created? set as the default theme otherwise continue to next steps.
+In this example the theme machine name is `my_new_theme`.
+The theme dependencies are already met in the Drupal standard installation.
+```
+lando drush theme:install my_new_theme
+```
+
+### Installing the node package dependencies and running a build.
 ```
 nvm use
 npm install
@@ -24,7 +28,7 @@ npm install
 npm run dev
 ```
 
-### Building the assets for deployment
+### Building the assets for deployment.
 ```
 npm run build
 ```

diff --git a/...tall/block.block.bixaluswds_main_menu.yml → ...tall/block.block.bixaluswds_main_menu.yml b/...tall/block.block.bixaluswds_main_menu.yml → ...tall/block.block.bixaluswds_main_menu.yml
@@ -6,9 +6,9 @@ dependencies:
   module:
     - system
   theme:
-    - starter_theme
+    - source_theme_name
 id: bixaluswds_main_menu
-theme: starter_theme
+theme: source_theme_name
 region: header
 weight: 0
 provider: null

diff --git a/...l/block.block.bixaluswds_sitebranding.yml → ...l/block.block.bixaluswds_sitebranding.yml b/...l/block.block.bixaluswds_sitebranding.yml → ...l/block.block.bixaluswds_sitebranding.yml
@@ -4,9 +4,9 @@ dependencies:
   module:
     - system
   theme:
-    - starter_theme
+    - source_theme_name
 id: bixaluswds_sitebranding
-theme: starter_theme
+theme: source_theme_name
 region: header
 weight: -2
 provider: null

diff --git a/...all/block.block.starter_theme_content.yml → ...block.block.source_theme_name_content.yml b/...all/block.block.starter_theme_content.yml → ...block.block.source_theme_name_content.yml
@@ -4,9 +4,9 @@ dependencies:
   module:
     - system
   theme:
-    - starter_theme
-id: starter_theme_content
-theme: starter_theme
+    - source_theme_name
+id: source_theme_name_content
+theme: source_theme_name
 region: content
 weight: -3
 provider: null

diff --git a/...ll/block.block.starter_theme_messages.yml → ...lock.block.source_theme_name_messages.yml b/...ll/block.block.starter_theme_messages.yml → ...lock.block.source_theme_name_messages.yml
@@ -4,9 +4,9 @@ dependencies:
   module:
     - system
   theme:
-    - starter_theme
-id: starter_theme_messages
-theme: starter_theme
+    - source_theme_name
+id: source_theme_name_messages
+theme: source_theme_name
 region: admin
 weight: -3
 provider: null

diff --git a/.../block.block.starter_theme_page_title.yml → ...ck.block.source_theme_name_page_title.yml b/.../block.block.starter_theme_page_title.yml → ...ck.block.source_theme_name_page_title.yml
@@ -2,9 +2,9 @@ langcode: en
 status: true
 dependencies:
   theme:
-    - starter_theme
-id: starter_theme_page_title
-theme: starter_theme
+    - source_theme_name
+id: source_theme_name_page_title
+theme: source_theme_name
 region: content
 weight: -4
 provider: null

diff --git a/...ock.starter_theme_primary_local_tasks.yml → ...source_theme_name_primary_local_tasks.yml b/...ock.starter_theme_primary_local_tasks.yml → ...source_theme_name_primary_local_tasks.yml
@@ -2,9 +2,9 @@ langcode: en
 status: true
 dependencies:
   theme:
-    - starter_theme
-id: starter_theme_primary_local_tasks
-theme: starter_theme
+    - source_theme_name
+id: source_theme_name_primary_local_tasks
+theme: source_theme_name
 region: admin
 weight: -4
 provider: null

diff --git a/starter_theme/gulpfile.js → source_theme_name/gulpfile.js b/starter_theme/gulpfile.js → source_theme_name/gulpfile.js
diff --git a/starter_theme/logo.svg → source_theme_name/logo.svg b/starter_theme/logo.svg → source_theme_name/logo.svg
diff --git a/starter_theme/package.json → source_theme_name/package.json b/starter_theme/package.json → source_theme_name/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "uswds_theme",
+  "name": "source_theme_name",
   "version": "3.0.0",
   "description": "",
   "main": "index.js",

diff --git a/starter_theme/starter_theme.info.yml → source_theme_name/source_theme_name.info.yml b/starter_theme/starter_theme.info.yml → source_theme_name/source_theme_name.info.yml
@@ -1,13 +1,14 @@
-name: Bixal USWDS starter theme
+name: Bixal USWDS source theme
 type: theme
 description: "Drupal theme for use with USWDS."
 core_version_requirement: "^10"
 base theme: bixaluswds
 version: '0.0.0'
 hidden: true
+starterkit: true
 
 libraries:
-  - starter_theme/base
+  - source_theme_name/base
 
 regions:
   admin: "Admin"

diff --git a/starter_theme/starter_theme.libraries.yml → ...heme_name/source_theme_name.libraries.yml b/starter_theme/starter_theme.libraries.yml → ...heme_name/source_theme_name.libraries.yml
@@ -1,7 +1,7 @@
 base:
   dependencies:
-    - starter_theme/uswds
-    - starter_theme/external_links
+    - source_theme_name/uswds
+    - source_theme_name/external_links
 
 uswds:
   css:

diff --git a/starter_theme/starter_theme.starterkit.yml → ...eme_name/source_theme_name.starterkit.yml b/starter_theme/starter_theme.starterkit.yml → ...eme_name/source_theme_name.starterkit.yml
diff --git a/source_theme_name/source_theme_name.theme b/source_theme_name/source_theme_name.theme
@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @file
+ * Functions to support theme templates.
+ */
+
+/**
+ * Implements hook_preprocess().
+ */
+function source_theme_name_preprocess(&$variables) {
+  $variables['uswds_img_path'] = '/themes/custom/source_theme_name/dist/assets/img';
+}
diff --git a/starter_theme/src/js/external-links.js → source_theme_name/src/js/external-links.js b/starter_theme/src/js/external-links.js → source_theme_name/src/js/external-links.js
diff --git a/starter_theme/src/js/theme-switcher.js → source_theme_name/src/js/theme-switcher.js b/starter_theme/src/js/theme-switcher.js → source_theme_name/src/js/theme-switcher.js
diff --git a/starter_theme/src/sass/_uswds-settings.scss → ..._theme_name/src/sass/_uswds-settings.scss b/starter_theme/src/sass/_uswds-settings.scss → ..._theme_name/src/sass/_uswds-settings.scss
diff --git a/starter_theme/src/sass/styles.scss → source_theme_name/src/sass/styles.scss b/starter_theme/src/sass/styles.scss → source_theme_name/src/sass/styles.scss
diff --git a/starter_theme/starter_theme.theme b/starter_theme/starter_theme.theme