Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
buttonwillowsix authored Dec 2, 2023
1 parent 2380326 commit ec1081b
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
# [ChEM-H Subtheme](https://github.com/SU-SWS/chem_h_subtheme)
##### Version: 8.x-1.0-dev
##### Version: 1.0.1

Changelog: [Changelog.txt](CHANGELOG.txt)

Description
---

The ChEM-H Subtheme is a Stanford sub-theme that works with the Stanford Basic theme.
The ChEM-H Subtheme is a Stanford sub-theme that works with the Stanford Basic theme. This is version 1 of the theme. It is used on the following sites.

Documentation
---
See subtheming guides and best practices here:
https://devguide.sites.stanford.edu/front-end/drupal/sub-themes
https://chemh-cbi.stanford.edu/ (v1)

https://medchem.stanford.edu/ (v1)

https://mskc.stanford.edu/ (v1)

https://proteinengineering.sites.stanford.edu/ (v1)

Installation
Features
---
1. Review the documentation link above for best practices, particularly the Do's and Don't's sections.
2. Fork or download this theme repository.
3. Change all theme file names from including "chem_h_subtheme" to including the machine name of your theme.
4. Run a search and replace throughout the theme files to replace "chem_h_subtheme" with the machine name of your theme.
5. Add any specific brand colors you need (in addition to the decanter colors that are already available) to src/scss/utilities/variables/_colors.scss.
See all the colors already available through decanter: https://decanter.stanford.edu/page/brand-design-elements-color/
6. If desired, add font settings if you need to override and use fonts other than decanter fonts ( https://decanter.stanford.edu/page/brand-design-elements-typography/ ) [link],
by defining a font library in the themename.libraries.yml file.
7. If desired, add button mixins in src/scss/utilities/mixins/_buttons.scss with your button styles and then reference them and use them in src/scss/theme/_button.scss.
8. If desired, add cta and link mixins in src/scss/utilities/mixins/_cta.scss with your button styles and then reference them and use them in src/scss/theme/_cta.scss.
9. If you want to skin or theme a component, like a paragraph, create a _mycomponent.scss file in src/scss/components folder. Consider using a subfolder like 'cards' or 'banners' if applicable.
Custom footer design
Favicon
Purple buttons
Variants for teal buttons
Minimal card variant

Configuration
---
Expand Down

0 comments on commit ec1081b

Please sign in to comment.