Skip to content
Snippets Groups Projects
Commit af4f230e authored by Mark Halliwell's avatar Mark Halliwell
Browse files

Consistently use ./THEMENAME in docs instead of ./subtheme

parent 5d9cce7b
No related branches found
Tags 8.x-1.0
No related merge requests found
......@@ -62,9 +62,9 @@ the file or directory inside it. For example, the file that is responsible for
displaying the text on this page is located at `./bootstrap/docs/README.md`.
When referring to files inside a sub-theme, they will always start with
`./subtheme/` and continue to specify the full path to the file or directory
inside it. For example, the primary file Drupal uses to determine if a theme
exists is: `./subtheme/subtheme.info.yml`, where `subtheme` is the machine name
of your sub-theme.
`./THEMENAME/`, where `THEMENAME` is the machine name of your sub-theme. They
will continue to specify the full path to the file or directory inside it. For
example, the primary file Drupal uses to determine if a theme
exists is: `./THEMENAME/THEMENAME.info.yml`.
[Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
......@@ -26,19 +26,22 @@ Once you've selected one of the above starterkits, here's how to install it:
1. Copy over one of the starterkits you have chosen from the
`./bootstrap/starterkits` directory into the `themes` directory.
2. Rename the directory to a unique machine readable name. This will be your
sub-theme's "name". For this example and future examples we'll use `subtheme`.
3. Rename `./subtheme/THEMENAME.starterkit.yml` to match the directory name and
append `.info.yml` (e.g. `./subtheme/subtheme.info.yml`).
4. Open `./subtheme/subtheme.info.yml` and change the name, description and any
other properties to suite your needs. Make sure to change the library name:
`- THEMENAME/globalstyling` to `- subtheme/globalstyling` as well.
5. Rename the sub-theme configuration files, located at: `./config/install/THEMENAME.settings.yml`
and `./config/schema/THEMENAME.schema.yml` to match the `subtheme` name (e.g.
`subtheme.settings.yml` and `subtheme.schema.yml`).
6. Open `./config/schema/subtheme.schema.yml` and change `- THEMENAME.settings:`
to `- subtheme.settings:` and label: `'THEMETITLE settings'` to
`'Subtheme settings'`
2. Rename the directory to a unique machine readable name. This is your sub-theme's
"machine name". When referring to files inside a sub-theme, they will always
start with `./THEMENAME/`, where `THEMENAME` is the machine name of your
sub-theme. They will continue to specify the full path to the file or
directory inside it. For example, the primary file Drupal uses to determine
if a theme exists is: `./THEMENAME/THEMENAME.info.yml`.
3. Rename `./THEMENAME/THEMENAME.starterkit.yml` to match
`./THEMENAME/THEMENAME.info.yml`.
4. Open `./THEMENAME/THEMENAME.info.yml` and change the name, description and any
other properties to suite your needs. Make sure to rename the library name as
well: `- THEMENAME/globalstyling`.
5. Rename the sub-theme configuration files, located at:
`./THEMENAME/config/install/THEMENAME.settings.yml` and
`./THEMENAME/config/schema/THEMENAME.schema.yml`.
6. Open `./THEMENAME/config/schema/THEMENAME.schema.yml` and rename
`- THEMENAME.settings:` and `'THEMETITLE settings'`
{.alert.alert-warning} **WARNING:** Ensure that the `.starterkit` suffix is
not present on your sub-theme's `.info.yml` filename. This suffix is simply a stop
......
......@@ -16,7 +16,7 @@ or provide additional custom CSS.
Read the @link subtheme Sub-theming @endlink parent topic.
## Override Styles {#styles}
Open `./subtheme/css/style.css` and modify the file to your liking.
Open `./THEMENAME/css/style.css` and modify the file to your liking.
## Override Settings {#settings}
Please refer to the @link theme_settings Sub-theme Settings @endlink topic.
......
......@@ -23,37 +23,37 @@ preprocessor.
Download and extract the **latest** 3.x.x version of
[Bootstrap Framework Source Files] into the root of your new sub-theme. After
it has been extracted, the directory should be renamed (if needed) so it reads
`./subtheme/bootstrap`.
`./THEMENAME/bootstrap`.
If for whatever reason you have an additional `bootstrap` directory wrapping the
first `bootstrap` directory (e.g. `./subtheme/bootstrap/bootstrap`), remove the
first `bootstrap` directory (e.g. `./THEMENAME/bootstrap/bootstrap`), remove the
wrapping `bootstrap` directory. You will only ever need to touch these files if
or when you upgrade your version of the [Bootstrap Framework].
{.alert.alert-warning} **WARNING:** Do not modify the files inside of
`./subtheme/bootstrap` directly. Doing so may cause issues when upgrading the
`./THEMENAME/bootstrap` directly. Doing so may cause issues when upgrading the
[Bootstrap Framework] in the future.
## Override Styles {#styles}
The `./subtheme/less/variable-overrides.less` file is generally where you will
The `./THEMENAME/less/variable-overrides.less` file is generally where you will
the majority of your time overriding the variables provided by the [Bootstrap
Framework].
The `./subtheme/less/bootstrap.less` file is nearly an exact copy from the
The `./THEMENAME/less/bootstrap.less` file is nearly an exact copy from the
[Bootstrap Framework Source Files]. The only difference is that it injects the
`variable-overrides.less` file directly after it has imported the[Bootstrap
Framework]'s `variables.less` file. This allows you to easily override variables
without having to constantly keep up with newer or missing variables during an
upgrade.
The `./subtheme/less/overrides.less` file contains various Drupal overrides to
The `./THEMENAME/less/overrides.less` file contains various Drupal overrides to
properly integrate with the [Bootstrap Framework]. It may contain a few
enhancements, feel free to edit this file as you see fit.
The `./subtheme/less/style.less` file is the glue that combines the
The `./THEMENAME/less/style.less` file is the glue that combines the
`bootstrap.less` and `overrides.less` files together. Generally, you will not
need to modify this file unless you need to add or remove files to be imported.
This is the file that you should compile to `./subtheme/css/styles.css` (note
This is the file that you should compile to `./THEMENAME/css/styles.css` (note
the same file name, using a different extension of course).
## Override Theme Settings {#settings}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment