Document user custom element hooks #2815

tsmanner · 2021-02-09T17:21:57Z

This is an enhancement or feature.

Summary

For simple css additions to a site, it would be nice to be able to include bare css files in the user site and have a way to add them to a site or page. The way to style a page with the lowest barriers to entry is to just write css and include the stylesheets in your <head> element. This PR implements optional the css key, for _config.yml and page YAML Front Matters, which contains a sequence of paths to css files. Site css files are included first, followed by page css files, in the <head> element of each page on the site, via the head.html include.

Simple documentation of the configuration values can be found in configuration.md:

Context

This is not related to any issues, just a desire to add some simple, custom styled, elements to a page. My particular case was to add alternating highlighting and underlines to digits in a numeric string to make it easier to pick out byte and nibble boundaries. It's useful for me at work to help correlate bit numbers to hex digits in some machine generated log files.

iBug · 2021-02-09T17:31:06Z

Sorry but I can hardly see any utility of this PR.

Global CSS is already easy enough to add and is documented here: https://mmistakes.github.io/minimal-mistakes/docs/stylesheets/#customizing

For "page CSS", I can think of two ways of doing so:

Use _includes/head/custom.html to add the exact Liquid code you introduced in this PR, which is documented here: https://mmistakes.github.io/minimal-mistakes/docs/stylesheets/#font-stacks
Add custom classes to the <body> element using page.classes in Front Matter, then apply some "site CSS" with a selector scoped for body.some-class. This is documented here: https://mmistakes.github.io/minimal-mistakes/docs/layouts/#layout-based-and-user-defined-classes

In fact, I've used both approaches for a year or so:

With that described, I'm not in favor of this PR at its status quo. You can, however, drop all the code changes and only amend the documentations, so users can more easily find these information.

Thank you for your interest in Minimal Mistakes theme. I appreciate how it's submitted in a good faith with good coding and documentation practices.

tsmanner · 2021-02-09T17:38:07Z

That makes sense, I was honestly expecting a response similar to this, but have been having trouble finding the "right" place to inject my css. My hacked solution was to add the <link> tag directly to the top of the page I wanted it in, but that was obviously a bad solution. I'll give those suggestions a shot, and expect that I'll drop the code change and modify the documentation update to point at those and give a quick inline example.

tsmanner · 2021-02-09T18:40:56Z

@iBug your suggestion worked on the first try, it's too bad it's buried in the documentation for using old font versions. I added some documentation on the Configuration page with a link to more details on the Stylesheets page. Thanks for the prompt response, and info!

iBug · 2021-02-09T19:15:04Z

Well, this is not the kind of guidance I expected.

Since we're utilizing _includes/head/custom.html, the introduction of {{ site.css }} is completely redundant - everything could be just laid out plain there, so why bother moving the actual URLs to another file?

For the page CSS part, I was looking for a ProTip block right under the "user-defined classes" section, mentioning the combined use of custom page classes and scoped site CSS as I've done. Utilizing _includes/head/custom.html for page CSS, on the other hand, isn't as bad as that for site CSS, so I'm neutral toward this.

The change in docs/_docs/05-configuration.md is also messy - it focuses on adding CSS via <link> tags, introducing more-than-necessary Liquid tags, and more importantly, it's at a wrong place. If you look closely, you'll find that the whole page talks about available settings via _config.yml. The insertion of overriding a custom include file is absurd. I'd suggest docs/_docs/06-overriding-theme-defaults.md as a better place for this text, but be sure to be "generic" about the usage of head/custom.html - it could be used for anything in the <head> part, not just CSS.

And two more points:

A good typewriting style is important. For example, there are two problems with Site and Page css:
- Its capitalization is not in line with other headings on the site. Sentence casing (not Title Casing) is used for all headings.
- Proper names and acronyms need correct capitalization. So it should be CSS, not css.
Similarly, a good Markdown typewriting style is also better than none. Perhaps you can give markdownlint a try
css is too generic for a config key name for a list of links to stylesheets. A longer name would be better while maintaining concision, like extra_css or head_css. These short and generic names are better reserved for the same generic purposes.

…d cleaned up some style in new sections of 16-stylesheets.md

tsmanner · 2021-02-09T20:49:56Z

That's all fair feedback, I've been writing stuff up the way I'm thinking about using it not the way it should be presented to all users.

Since we're utilizing _includes/head/custom.html, the introduction of {{ site.css }} is completely redundant - everything could be just laid out plain there, so why bother moving the actual URLs to another file?

The thought behind this was for future additions to my own site, it's easier to find and to add a line to the _config.yml than copy/paste <link> tags in _includes/head/custom.html. I agree that it is functionally the same, which is why I included both approaches in the longer example in _docs/_docs/16-stylesheeds.md. That said, the way I presented it there is my preference for putting as much site configuration in _config.yml as possible, similarly to the way scripts are handled with the head_scripts, footer_scripts, and after_footer_scripts.

I am curious why CSS is expected to be handled entirely differently than JavaScript in regards to configuration? I am a naive web developer, in my limited experience, they tend to be handled similarly, as they often work together to render the page. Regardless of that, I care much more about having some example of page CSS configuration than the site wide stuff, so I would be happy even reducing this to a small segment in docs/_docs/06-overriding-theme-defaults.md describing how to use the configuration available to have page-specific CSS (and probably JavaScript) via the custom head/footer files.

I've made a quick change to the branch, removing the section from docs/_docs/05-configuration.md and working on the typewriting style in 16-stylesheets.md.

tsmanner · 2021-02-09T23:07:59Z

I've been thinking about this more, and have been trying to find the right spot to put some example of using _includes/head/custom.html to include page-specific CSS. I'm not coming up with any places that feel quite right. A one or two sentence ProTip in docs/_docs/06-overriding-theme-defaults.md is reasonable, but doesn't seem like the right place to put any sort of example.

I don't see any documentation of the html customization points, only some mentions that they exist. For example, 02-structure.md mentions that _includes/footer and _includes/head are for "custom snippets," and _includes/analytics-providers mentions "Google and custom." There is no mention of what in there is customizable, to determine that I had to start digging through the .html source files in the repository to see what gets included and seems to have something like "custom" in the name.

I don't think the right place to talk about how to use the built-in customization points is docs/_docs/06-overriding-theme-defaults.md, since they're not overriding anything. Would it be possible to add a page under the CUSTOMIZATION sidebar nav that was something like docs/_docs/XY-custom-elements.md? This page would list the files that are already included by the theme, but that are intended to contain user data, like _includes/head/custom.html, and give a brief description of how/where they're included. Including an example or two I think would be helpful. This would be especially useful for people, like myself, that are using minimal-mistakes via jekyll-remote-theme.

Something along these lines:

_includes/head/custom.html

This file is included just before the close of the <head> tag in the default layout

_includes/footer/custom.html

This file is included just after the open of the <footer> tag in the default layout

…ing-theme-defaults.md

iBug · 2021-02-10T06:49:30Z

Given how files under docs/_docs are laid out, it's not easy (or clean) to add a new file into that list.

There are two other places I found suitable for the mentioning of HTML addition points, 02-structure.md and 10-layouts.md. If you find it easier to discover, I'm fine if you add the same mentioning in both 16-stylesheets.md and 17-javascript.md as well (just be sure to link to other pages when necessary, so as to reduce the amount of duplicated content).

About the reason CSS is handled differently than JavaScript, I go for Jekyll's built-in processing for Sass/SCSS. And since the theme already supports per-page classes at <body> level, it's better not to complicate things when you can do it cleanly.

And last but not least, the current way head_scripts, footer_scripts etc. are laid out is as redundant as it is. The best way of course, is to drop them altogether and advocate the "HTML insertion points" approach. This is too breaking a change that better fits a major release, like 4.100.0 or 5.0.

…head and footer.

tsmanner · 2021-02-11T14:56:09Z

I got back to this this morning and made the following changes:

Added a line pointing to custom.html beneath the head and footer paths in 02-structure.md and mentioned creating the files locally in the note above it.
Added a section in 10-layouts.md that discusses head and footer includes, along with two examples of adding page-specific CSS and JavaScript using them.

I can continue through the other template includes for custom HTML injection points and add sections there for each of them as well, though I probably won't have very good examples to include. @iBug let me know what you think

iBug

Looks good to me. Need @mmistakes to make more reviews.

* Added documentation for including custom CSS on a site or page * Removed non-configuration related content from 05-configuration.md and cleaned up some style in new sections of 16-stylesheets.md * Moved small custom head documentation to a ProTip in _docs/06-overriding-theme-defaults.md * Cleaned up some documentation, and added some example uses of custom head and footer. * Replace double space with single * Replace double spaces with single Co-authored-by: Tom Manner <tsmanner@us.ibm.com> Co-authored-by: Michael Rose <mmistakes@users.noreply.github.com>

@iBug

* Change tab indent to space for consistency (mmistakes#2614) * Fix link for author name (mmistakes#2575) Missed from bcd6126 * Update CHANGELOG and history * Update zh-cn (mmistakes#2576) * Update zh-cn * Update ui-text.yml * Update CHANGELOG and history * Use layout: none instead of null (mmistakes#2617) * Use layout: none instead of null * Update CHANGELOG and history * Configure entries layout `list` or `grid` (mmistakes#2616) * Configure entries layout `list` or `grid` This allows to use grid layout on `page.entries_layout` on the home layout. Included a break since when using grid the post images are too close to the horizontal line bellow `posts` text. There's a entries div now surrounding the posts since the first row of the grid was having a slight padding on the left. The home now behaves like posts/categories/tags pages with grid but including the paginator. For best results on desktop use `classes: wide` and `paginate: 4` on `_config.yml` (or multiples of 4 if you want more rows) * Fix indent * Archive subtitle leaves space on the bottom * Now space is added through style * Update CHANGELOG and history * Include documentation for home page grid view * Update 10-layouts.md * Update UI text for zh-CN and zh-TW (mmistakes#2626) * Update UI text for zh-CN and zh-TW * Update CHANGELOG and history Not touching last_modified_at this time - it's messy enough * Update documentation for mmistakes#2621 (mmistakes#2624) * Update documentation for mmistakes#2621 * Update CHANGELOG and history * Update last_modified_at * remove hidden posts from `/posts` (mmistakes#2625) * Update CHANGELOG and history * Show date of posts (mmistakes#2526) * add date to read-time.html * add option for show_date, dynamic icon style * change read-time to post__meta * cleanup post__metal.html * cleanup post__meta include variables * put date before read time * remove space in include variable * allow customisation of post__meta separator * add some documentation * oops fix typo derp * add post date image * change page meta separator customisation to CSS * Update CHANGELOG and history * Fix grammar * Remove extra back ticks * Release 4.20.0 💎 * Update remote_theme * Fix grammar * Fix grid `entries_layout` in home.html * Release 4.20.1 💎 * Update remote_theme version * Fix `entries_layout: grid` Close mmistakes#2639 * Update CHANGELOG and history * Change "fa" to "fas" for Font Awesome 5 (mmistakes#2649) * main.js: fa -> fas for FA 5 * Update CHANGELOG and history * added css changes, modified jquery.greedy-navigation and built the main.min.js again * Removed duplicated CSS definitions (mmistakes#2666) * Update CHANGELOG and history * Added article:author used by Pinterest (mmistakes#2670) * Update CHANGELOG and history * Refactor page meta (mmistakes#2641) * Rename include * Add grid view test pages * Rename `.post__meta-sep` and use CSS to add line break * Improve collection grid archive * Improve page grid archive * Enable `grid` * Don't show date icon if there is no `date` value * Add blank line at EOF * Add space * Wrap date and reading time in named `span` elements * Update CHANGELOG and history * Bump copyright year * Fix typo Close mmistakes#2678 * Fix broken link in documentation Close mmistakes#2677 * Release 4.20.2 💎 * Bump theme version * Update allejo/jekyll-toc to v1.0.14 https://github.com/allejo/jekyll-toc/releases/tag/v1.0.14 * Fix dead link to "CI services" Jekyll (mmistakes#2692) * Fix mmistakes#2635 * Update CHANGELOG and history * Update README.md * Update CONTRIBUTING.md * Update stale.yml * Fix closing tag of figures without captions in lists (mmistakes#2697) When the figure helper is used in a list, which can be either ordered or unordered, and no caption is specified, a line with text "</figure>" will be shown below the figure on the rendered page. This is because, if the '{% if include.caption %}' evaluates to false, the lines between that 'if' statement and '{% endif %}' will be emptied, not removed, so the block will be filled by empty lines. HTML ignores redundant empty lines, but Markdown takes them seriously. In addition, Markdown expects proper indentation of lines inside lists, and the closing '</figure>' tag is not indented. When combined, the empty space and absence of indentation cause Markdown to process the '</figure>' tag as a separate paragraph instead of an HTML tag, thus the text for the tag is directly rendered on the page. The fix for this issue is very simple: remove the empty space when 'include.caption' is false. As described in <https://shopify.github.io/liquid/basics/whitespace/>, this can be done by adding hyphens to the 'if' and 'endif' tags. * Update CHANGELOG and history * Update CHANGELOG and history * Norwegian translation (mmistakes#2702) * Update CHANGELOG and history * Update CHANGELOG and history * Fix a small typo in documentation * Update ui-text.yml for Vietnamese * Added some translation for indonesian language * Update indonesian translation * Update CHANGELOG and history * Update CHANGELOG and history * Update jQuery to 3.5.1 (mmistakes#2713) * Update jQuery to 3.5.1 Closes mmistakes#2712 * Build NodeJS Run using `npm run build:js` * Update CHANGELOG and history * Release 4.21.0 💎 * Update `remote_theme` version * Fix heading level * Fix Font Awesome icon color in various skins Close mmistakes#2724 * Update remote theme instructions * jekyll-install-cache gem should be added to Gemfile * Update CHANGELOG and history * indonesian translation minor typo fix (mmistakes#2731) * Update CHANGELOG and history * Update 404.md (mmistakes#2737) Removed Google Search script which no longer worked. mmistakes#2597 * Update CHANGELOG and history * Delete support.md * Delete feature_request.md * Update allejo/jekyll-toc to v1.1.0, skip headings without an ID (mmistakes#2752) * Update allejo/jekyll-toc to v1.1.0, skip headings without an ID https://github.com/allejo/jekyll-toc/releases/tag/v1.1.0 * Update CHANGELOG and history * Add toc_sticky parameter's description (mmistakes#2741) * Update CHANGELOG and history * Fix typo * Add hebrew translation (mmistakes#2760) * Update CHANGELOG and history * Add .webp to supported lightbox images (mmistakes#2788) * Update CHANGELOG and history * Remove google's fixurl.js from example (mmistakes#2789) Unfortunately, it no longer exists. * Update CHANGELOG and history * Upgrade Lunrjs to 2.3.9 and switch to relative_url (mmistakes#2805) * Update Lunr to 2.3.9 * Switch from absolute_url to relative_url * Update CHANGELOG and history * Allow custom gradient in page header overlays (mmistakes#2806) * Allow custom gradient in page header overlays * Update documentation * Update CHANGELOG and history * Add toggle option for RSS feed visibility (mmistakes#2787) * add a "hide" value in config for atom * Update footer to use param * update header to use param * Update docs to note configuration * undo formatting * use unless syntax * unless syntax and indentation * indentation * Update CHANGELOG and history * Use sort_natural instead of custom-logic (mmistakes#2756) * Update CHANGELOG and history * Allow custom sorting for collections (mmistakes#2723) * Allow custom sorting for collections * Update docs with custom sort of collections * Refactoring * Update CHANGELOG and history * Release 4.22.0 💎 * Update * Force rebuild of demo site * Fix typos * Remove G-stuff CSS (mmistakes#2852) (mmistakes#2855) * Add alt attr to site logo in masthead (mmistakes#2824) Co-authored-by: Michael Rose <mmistakes@users.noreply.github.com> * Add note on TOC heading level issue (mmistakes#2902) mmistakes#2892 (comment) * Add Baidu site verfication (mmistakes#2830) * Update CHANGELOG and history * Remove all references to official public Staticman API instance. (mmistakes#2831) * Updated Staticman docs * remove any ref to official public instance in docs * remove fallback instance for staticman v2 left staticman v1 untouched as I dunno how to deal with that * Update CHANGELOG and history * Datetime format (mmistakes#2844) * datetime_format * page__meta * page__date * page__date test * update docs * update docs * Update CHANGELOG and history * Color notices based on skin colors instead of fixed values (mmistakes#2887) * Made notice Sass color mixing in based on $background-color and $text-color instead of hard-coded black and white values. * Made some style adjustments to notices to improve readability. Notice links are slightly darkened from the notice color, mostly because the gray-on-gray default notice links were very hard to read. Rather than being $notice-color, they are `mix(#000, $notice-color, 10%)`. The notice background mix and code-background mix can now be set with the SCSS variables $notice-background-mix and $code-notice-background-mix. The default mix for background was adjusted to 80%, from 90%. The default mix for code-background was adjusted to 90%, from 95%. Skins that still didn't read well were adjusted individually. * Adjusted sunrise $notice-background-mix to 75% * Adjusted dark theme notice background mix colors back to the default Co-authored-by: Tom Manner <tsmanner@us.ibm.com> * Update CHANGELOG and history * Document user custom element hooks (mmistakes#2815) * Added documentation for including custom CSS on a site or page * Removed non-configuration related content from 05-configuration.md and cleaned up some style in new sections of 16-stylesheets.md * Moved small custom head documentation to a ProTip in _docs/06-overriding-theme-defaults.md * Cleaned up some documentation, and added some example uses of custom head and footer. * Replace double space with single * Replace double spaces with single Co-authored-by: Tom Manner <tsmanner@us.ibm.com> Co-authored-by: Michael Rose <mmistakes@users.noreply.github.com> * Update CHANGELOG and history * Add Arabic Translation 📝 * Update onchange and uglify-js dependencies * Fix typo * Update * Update 14-helpers.md (mmistakes#2940) Fix missing backtick. * Update CHANGELOG and history * Fix Jekyll environment note in configuration documentation Close mmistakes#2912 * Fix typo Close mmistakes#2911 * Update stale action * Update stale.yml * FIx menu toggle ref: mmistakes#2957 * Release 4.23.0 💎 * Update CHANGELOG and history * Bump theme version * Enable auto ads * Update Google Adsense * Update FUNDING.yml * Update FUNDING.yml * Update README.md * Disable auto ads * Update support buttons * Update Adsense * Add banner above related posts * Update FUNDING.yml * Update FUNDING.yml * Fix broken image Close mmistakes#3013 * feat: Search icon in masthead is a Font Awesome icon. (mmistakes#2774) * feat: Allow search icon in masthead to be set to a Font Awesome icon. * fix indentations * Users wishing to avoid FontAwesome should override _includes/masthead.html * Update CHANGELOG and history * Loads font-awesome asynchronously (mmistakes#2967) Loading font-awesome asynchronously allows to display the site faster. This change is advised by google pagespeed insights * Update CHANGELOG and history * Remove H2 as it is not important to site structure (mmistakes#3012) This should not use a H2, as that is not an important headline, and thus a H2 here would probably hurt in page SEO. * Update CHANGELOG and history * Fix broken links in documentation Close mmistakes#3004 * Remove `tabindex="-1"` from `input` elements in `search.html` layout Make `input` elements accessible by keyboard. Fixes mmistakes#2982 * Update README text for Gumshoejs license (mmistakes#3024) * Update CHANGELOG and history * Remove IE9 flexbox fallback (mmistakes#3042) IE9 is absolutely, completely, totally dead. it's marketshare is less than 0.1%. REF: https://caniuse.com/usage-table Save some bytes in the HTML for all users by removing the fallback inline CSS. * Update CHANGELOG and history * Add giscus support (mmistakes#3022) * Add script in same style as utterances But adjusted for the various filed differences * Add initial script * Add default settings * Update changelog * Add feature to readme * Add comments html * add comment provider include * update config in docs * Add URL for additional reference * docs for giscus comments * Unrelated bugfix: add missing version separator So that things match the "history" doc. * add space * update history doc * update about doc * add to test config yaml * remove unnecessary / incorrect async attribute * probably should pass the right config paths * lowercase the repo name * Update docs to address '1' and '0' for reactions_enabled Figured I'd match the giscus format rather than convert a boolean to an int there. * update two additional docs * docs wording fix * Release 4.24.0 💎 * Update version * Remove site.url from first breadcrumb link (mmistakes#3051) * Remove site.url from first breadcrumb link Fixes mmistakes#3050 * Use relative_rul filter instead of site.baseurl * Update CHANGELOG and history * Fixed a grammar error in the german translation (mmistakes#3063) * Update CHANGELOG and history * fix: change heading tag of related posts section from `h4` to `h2` for SEO enhancement (mmistakes#3064) * Update heading tag from `h4` to `h2` * Update heading tag from `h4` to `h2` * Update CHANGELOG and history * Add instructions on how to unminify main.js for easier browser debugging (mmistakes#3055) * Add instructions on how to unminify main.js for easier browser debugging * Fixed Markdown style like sggested by @iBug * Update CHANGELOG and history * Make small grammar changes * Update 01-quick-start-guide.md * Add Microformats (mmistakes#3052) * Add rel=me to author profile links * Add h-card Microformats markup * Add h-entry microformat markup * Fix missing anchor tag * Fix h-entry microformat markup on single template * Use minimal subset of Microformat elements * Move dt-published to `page__date.html` and remove dt-updated * Remove "author" and "summary" Leaves "url" as a hidden element * Add page link to h1 tag The h1 tag now contains the Schema-org `url` itemprop and the Microformats `url` class in an anchor tag. The anchor tag is styled to not look like a link. * Put author 'u-url' on author__name h3 This also puts the same `{{ author.home | default: '/' | absolute_url }}` construct on `author__avatar` to remove the Jekyll `author.home` conditional. Also addresses SCSS text color error. * Update CHANGELOG and history * Enable toc sidebar scrolling (mmistakes#2874) * Enable toc sidebar scrolling * Refactor style rules * Move style rules from 'navigation' to 'sidebar' * Remove custom scrollbar styles * Enable sticky toc on test post * Update CHANGELOG and history * Add margin around Google ads * Add role to search (mmistakes#3086) * Update CHANGELOG and history * Added Danish translations (mmistakes#3095) * Added Danish translations * Fixed wrong commit. * Update CHANGELOG and history * Enable magnific popup on <a> tags only when it has <img> (mmistakes#3114) * Update CHANGELOG and history * Remove extra semi-colon * Bump path-parse from 1.0.6 to 1.0.7 Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7. - [Release notes](https://github.com/jbgutierrez/path-parse/releases) - [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7) --- updated-dependencies: - dependency-name: path-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Update CHANGELOG and history * include video does not survive compress.html (mmistakes#3117) * Update CHANGELOG and history * Use GitHub issue templates (mmistakes#3133) https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository * Delete stale.yml * Delete stale.yml * Added optional label attribute (mmistakes#3128) Added label attribute as per utterances optional label setting. * Fix broken link & Add Baidu site verification (mmistakes#3139) * Fix broken link Link to Bing Webmaster Tools was broken. * Fix broken link Link to Open Graph debug tool was broken. * Add Baidu site verification (mmistakes#2830) Added `baidu_site_verification` to `_config.yml` * Making verbiage consistent w/current _config.yml (mmistakes#3180) The plugin in question comes by-default listed in _config.yml ; it's better to say that the user must _retain_ it as listed, not that the user needs to add it. * Link clarifying adding plugins (mmistakes#3181) The phrase "put them here!" doesn't sufficiently clarify what to do; I add link to the Jekyll documentation with the proper syntax. * feat: Sort comments by date ascending (mmistakes#3184) * Update Brazilian Portuguese translation (mmistakes#3204) * Update Brazilian Portuguese translation * Revert some translations to reduce friction * Update CHANGELOG and history * Update CHANGELOG and history * Fix keybase class (mmistakes#3221) * Fix keybase class * Fix fas->fab * Update CHANGELOG and history * ✏ fix typo (mmistakes#3232) * Update CHANGELOG and history * Add missing comma (mmistakes#3318) Co-authored-by: Yuchen Zhong <yuchen21@fb.com> * Update CHANGELOG and history * Automatically close invalid PRs using GitHub Actions (mmistakes#3313) * Try auto-closing bad PRs * Include empty PR body as well * Add "Type: Invalid" label as well * Update CHANGELOG and history * Added sameAs (mmistakes#3087) * Update CHANGELOG and history * Use <a> color for blockquote.notice border (mmistakes#3140) Close mmistakes#3068 * Update CHANGELOG and history * Fix inline code style not applied to stylized text (mmistakes#3253) * bug: inline code style not applied to stylized text * Use double colons for pseudoelements * Update CHANGELOG and history * Update to Jquery 3.6.0 (mmistakes#3254) * Update CHANGELOG and history * fix typo about loading javascript in footer (mmistakes#3350) * Update CHANGELOG and history * add optinal lunr searching of pages (mmistakes#3352) * Update CHANGELOG and history * Exclude `main.scss` from Lunr search index * Add Kiswahili translation (mmistakes#3489) * Add Kiswahili translation * Add Kiswahli to README * Add Kiswahili to documentation * Update * Update attribution link (mmistakes#3553) * Update CHANGELOG and history * Update link to Font Awesome gallery (mmistakes#3599) * Update CHANGELOG and history * Make it possible to enable breadcrumbs per page (mmistakes#3096) * Make it possible to disable breadcrumbs per page * Update single.html * Update single.html * Update algolia-search-scripts.html (mmistakes#3102) Fix issue mmistakes#3101 * Update CHANGELOG and history * Replace with public YouTube video Close mmistakes#3649 * Replace with public YouTube video embeds * Update CHANGELOG and history * Fix mmistakes#3096 enabling breadcrumb on all pages (mmistakes#3668) * Remove IE9 upgrade notice (mmistakes#3666) * Update CHANGELOG and history * Fix mmistakes#3668 breaking "disable per-page when globally enabled" (mmistakes#3669) * Fix mmistakes#3668 breaking "disable per-page when globally enabled" * `default:` filter doesn't fit here https://shopify.github.io/liquid/filters/default/ * Update CHANGELOG and history * Improve PR close auto-comment message (mmistakes#3713) * Improve auto-comment message * Lock these PRs after closing * add webrick * whatever, line ending perhaps * bug fix --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: iBug ♦ <git@ibugone.com> Co-authored-by: dianlujitao <dianlujitao@gmail.com> Co-authored-by: Michael Rose <est.michael@gmail.com> Co-authored-by: 谭九鼎 <109224573@qq.com> Co-authored-by: Juan Ara <juan@juanylaura.es> Co-authored-by: Michael Rose <mmistakes@users.noreply.github.com> Co-authored-by: Andrey Kartashov <gorilych@gmail.com> Co-authored-by: Lim Jing Heng <limjh16@gmail.com> Co-authored-by: Miguel Belardinelli Prytoluk <prytolukster@gmail.com> Co-authored-by: Johannes Ganzenmüller <jganzenmller@ebay.com> Co-authored-by: Lars Olesen <lars@intraface.dk> Co-authored-by: Leo <liaoyuan@gmail.com> Co-authored-by: Kai A <kai.andresen@gmail.com> Co-authored-by: Quan <8580008+quanengineering@users.noreply.github.com> Co-authored-by: M. Akhyar Rahman H <akhyarrh@users.noreply.github.com> Co-authored-by: Mitchell Skaggs <skaggsm333@gmail.com> Co-authored-by: Susan Stevens <susan.stevens10@gmail.com> Co-authored-by: Jip-Hop <Jip-Hop@live.nl> Co-authored-by: gricn <gricn666@gmail.com> Co-authored-by: Uri Brecher <uri.brecher@gmail.com> Co-authored-by: PHOENiX <rlaphoenix@pm.me> Co-authored-by: Sean Killeen <SeanKilleen@gmail.com> Co-authored-by: Johannes Ganzenmüller <johannes.ganzenmueller@gmail.com> Co-authored-by: Nicolas Elie <40382614+n-elie@users.noreply.github.com> Co-authored-by: luweizheng <luweizheng36@hotmail.com> Co-authored-by: Vincent Tam <VincentTam@users.noreply.github.com> Co-authored-by: Tom Manner <zephrincochrane@gmail.com> Co-authored-by: Tom Manner <tsmanner@us.ibm.com> Co-authored-by: ShifraSec <48570596+MoElaSec@users.noreply.github.com> Co-authored-by: David Lechner <david@lechnology.com> Co-authored-by: Randall Wood <297232+rhwood@users.noreply.github.com> Co-authored-by: Guillaume Gautreau <guillaume+github@ghusse.com> Co-authored-by: Christian Oliff <christianoliff@pm.me> Co-authored-by: Erik Westrup <erik.westrup@gmail.com> Co-authored-by: Anton Brall <github@antonbrall.de> Co-authored-by: Kulbhushan Chand <17742733+kulbhushanchand@users.noreply.github.com> Co-authored-by: Peter Murray <jester@dltj.org> Co-authored-by: Johnson <20457146+j3soon@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: John Scott <68079471+JohnScottUK@users.noreply.github.com> Co-authored-by: Nathan Cho <ntcho13@gmail.com> Co-authored-by: Jason Hemann <jason.hemann@gmail.com> Co-authored-by: Daniel Schroeder <deadlydog@hotmail.com> Co-authored-by: Georger Araújo <4930759+georgeraraujo@users.noreply.github.com> Co-authored-by: Andrew McIntosh <amcintosh@users.noreply.github.com> Co-authored-by: Sander Holvoet <holvoetsander@gmail.com> Co-authored-by: Yuchen <yzhong52@users.noreply.github.com> Co-authored-by: Yuchen Zhong <yuchen21@fb.com> Co-authored-by: Nicholas Perry <ape.inago@gmail.com> Co-authored-by: Benson Muite <bkmgit@users.noreply.github.com> Co-authored-by: FavorMylikes <FavorMylikes@users.noreply.github.com>

Added documentation for including custom CSS on a site or page

ff96f00

tsmanner force-pushed the custom-css branch from 29768ef to ff96f00 Compare February 9, 2021 18:40

Removed non-configuration related content from 05-configuration.md an…

e1fcc9f

…d cleaned up some style in new sections of 16-stylesheets.md

Moved small custom head documentation to a ProTip in _docs/06-overrid…

b02a946

…ing-theme-defaults.md

tsmanner changed the title ~~Allow users to add custom css to site and page~~ Document user custom element hooks Feb 9, 2021

Cleaned up some documentation, and added some example uses of custom …

f488970

…head and footer.

iBug approved these changes Feb 11, 2021

View reviewed changes

mmistakes added Status: Accepted Type: Enhancement labels Apr 13, 2021

mmistakes added 2 commits April 13, 2021 16:07

Replace double space with single

18034fa

Replace double spaces with single

30ebc35

mmistakes merged commit de68707 into mmistakes:master Apr 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document user custom element hooks #2815

Document user custom element hooks #2815

tsmanner commented Feb 9, 2021

iBug commented Feb 9, 2021 •

edited

Loading

tsmanner commented Feb 9, 2021

tsmanner commented Feb 9, 2021

iBug commented Feb 9, 2021 •

edited

Loading

tsmanner commented Feb 9, 2021

tsmanner commented Feb 9, 2021

iBug commented Feb 10, 2021

tsmanner commented Feb 11, 2021

iBug left a comment

Document user custom element hooks #2815

Document user custom element hooks #2815

Conversation

tsmanner commented Feb 9, 2021

Summary

Context

iBug commented Feb 9, 2021 • edited Loading

tsmanner commented Feb 9, 2021

tsmanner commented Feb 9, 2021

iBug commented Feb 9, 2021 • edited Loading

tsmanner commented Feb 9, 2021

tsmanner commented Feb 9, 2021

Something along these lines:

_includes/head/custom.html

_includes/footer/custom.html

iBug commented Feb 10, 2021

tsmanner commented Feb 11, 2021

iBug left a comment

Choose a reason for hiding this comment

iBug commented Feb 9, 2021 •

edited

Loading

iBug commented Feb 9, 2021 •

edited

Loading