mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-07 20:41:22 -06:00
c2ec3d89c2
This is a catch-all PR that modernizes and updates our Stylelint config, and resolves all open issues. This is a pretty big change - so I want to update all of our related dependencies in lockstep.
In particular, this PR
- [x] updates stylelint to `v14`
- [x] adds in the standard stylelint config for SCSS (`stylelint-config-standard-scss`)
- [x] swaps out `stylelint-config-prettier` for `stylelint-config-prettier-scss`
- [x] ~~properly update `@primer`-related plugins:~~ completely remove `primer` from our configuration
- [x] autofix, manually resolve, or disable all newly-introduced lint errors; **I've avoided manually resolving errors that would be a behavioural change**
- [x] re-runs `npm run format`
See the "next steps" section on some extra thoughts on disabling errors.
(implicitly, I'm also using node 16/the new package-lock format).
### disabling rules and next steps
I've introduced several new disabled rules. Let me quickly explain what's going on; there are two categories of rules I've disabled:
1. rules that were temporary disables; they were frequent enough that I couldn't manually resolve them, but should be simple. **I plan on opening issues to re-enable each of these rules**, just after this PR
- `declaration-block-no-redundant-longhand-properties`: this is just tedious and error-prone
- `no-descending-specificity`: this one is tricky since it could have impacts on the cascade (though that seems unlikely)
- `scss/no-global-function-names`: I think we need to [import map and then use `map.get`](https://stackoverflow.com/questions/64210390/sass-map-get-doesnt-work-map-get-does-what-gives), but I'll leave this as out of scope for now
2. rules that are long-term disables; due to the SASS-based nature of our theme, I think we'll keep these in limbo
- `alpha-value-notation` causes problems with SASS using the `modern` syntax - literals like `50%` are not properly interpolated, and they cause formatting issues on the site
- `color-function-notation` also causes problems with SASS, but in this case the `modern` syntax breaks SASS compilation; we're not alone (see this [SO post](https://stackoverflow.com/questions/71805735/error-function-rgb-is-missing-argument-green-in-sass)).
In addition, we have many inline `stylelint-disable` comments. I'd open a separate issue to audit them, especially since I think some disables are unnecessary.
### on Primer
**note: there hasn't been much other discussion, so I'm going to remove primer's stylelint config.**
If I do add `@primer/stylelint-config`, I get *a ton* of errors about now using `@primer`'s in-built SCSS variables. I imagine that we probably won't want to use these presets (though I could be wrong). In that case, I think we could either:
1. disable all of those rules
4. not use `@primer/stylelint-config`, since we're not actually using primer, and shift back to the standard SCSS config provided by Stylelint
~~Any thoughts here? I also don't have the original context as to why we do use the primer rules, perhaps @pmarsceill can chime in?~~
241 lines
3.6 KiB
SCSS
241 lines
3.6 KiB
SCSS
@charset "UTF-8";
|
|
|
|
// Styles for rendered markdown in the .main-content container
|
|
// stylelint-disable selector-no-type, max-nesting-depth, selector-max-compound-selectors, selector-max-type, selector-max-specificity, selector-max-id
|
|
|
|
.main-content {
|
|
line-height: $content-line-height;
|
|
|
|
ol,
|
|
ul,
|
|
dl,
|
|
pre,
|
|
address,
|
|
blockquote,
|
|
.table-wrapper {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
a {
|
|
overflow: hidden;
|
|
text-overflow: ellipsis;
|
|
white-space: nowrap;
|
|
}
|
|
|
|
ul,
|
|
ol {
|
|
padding-left: 1.5em;
|
|
}
|
|
|
|
li {
|
|
.highlight {
|
|
margin-top: $sp-1;
|
|
}
|
|
}
|
|
|
|
ol {
|
|
list-style-type: none;
|
|
counter-reset: step-counter;
|
|
|
|
> li {
|
|
position: relative;
|
|
|
|
&::before {
|
|
position: absolute;
|
|
top: 0.2em;
|
|
left: -1.6em;
|
|
color: $grey-dk-000;
|
|
content: counter(step-counter);
|
|
counter-increment: step-counter;
|
|
@include fs-3;
|
|
|
|
@include mq(sm) {
|
|
top: 0.11em;
|
|
}
|
|
}
|
|
|
|
ol {
|
|
counter-reset: sub-counter;
|
|
|
|
> li {
|
|
&::before {
|
|
content: counter(sub-counter, lower-alpha);
|
|
counter-increment: sub-counter;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
ul {
|
|
list-style: none;
|
|
|
|
> li {
|
|
&::before {
|
|
position: absolute;
|
|
margin-left: -1.4em;
|
|
color: $grey-dk-000;
|
|
content: "•";
|
|
}
|
|
}
|
|
}
|
|
|
|
.task-list-item {
|
|
&::before {
|
|
content: "";
|
|
}
|
|
}
|
|
|
|
.task-list-item-checkbox {
|
|
margin-right: 0.6em;
|
|
margin-left: -1.4em;
|
|
|
|
// The same margin-left is used above for ul > li::before
|
|
}
|
|
|
|
hr + * {
|
|
margin-top: 0;
|
|
}
|
|
|
|
h1:first-of-type {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
dl {
|
|
display: grid;
|
|
grid-template: auto / 10em 1fr;
|
|
}
|
|
|
|
dt,
|
|
dd {
|
|
margin: 0.25em 0;
|
|
}
|
|
|
|
dt {
|
|
grid-column: 1;
|
|
font-weight: 500;
|
|
text-align: right;
|
|
|
|
&::after {
|
|
content: ":";
|
|
}
|
|
}
|
|
|
|
dd {
|
|
grid-column: 2;
|
|
margin-bottom: 0;
|
|
margin-left: 1em;
|
|
|
|
blockquote,
|
|
div,
|
|
dl,
|
|
dt,
|
|
h1,
|
|
h2,
|
|
h3,
|
|
h4,
|
|
h5,
|
|
h6,
|
|
li,
|
|
ol,
|
|
p,
|
|
pre,
|
|
table,
|
|
ul,
|
|
.table-wrapper {
|
|
&:first-child {
|
|
margin-top: 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
dd,
|
|
ol,
|
|
ul {
|
|
dl:first-child {
|
|
dt:first-child,
|
|
dd:nth-child(2) {
|
|
margin-top: 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
.anchor-heading {
|
|
position: absolute;
|
|
right: -$sp-4;
|
|
width: $sp-5;
|
|
height: 100%;
|
|
padding-right: $sp-1;
|
|
padding-left: $sp-1;
|
|
overflow: visible;
|
|
|
|
@include mq(md) {
|
|
right: auto;
|
|
left: -$sp-5;
|
|
}
|
|
|
|
svg {
|
|
display: inline-block;
|
|
width: 100%;
|
|
height: 100%;
|
|
color: $link-color;
|
|
visibility: hidden;
|
|
}
|
|
}
|
|
|
|
.anchor-heading:hover,
|
|
.anchor-heading:focus,
|
|
h1:hover > .anchor-heading,
|
|
h2:hover > .anchor-heading,
|
|
h3:hover > .anchor-heading,
|
|
h4:hover > .anchor-heading,
|
|
h5:hover > .anchor-heading,
|
|
h6:hover > .anchor-heading {
|
|
svg {
|
|
visibility: visible;
|
|
}
|
|
}
|
|
|
|
summary {
|
|
cursor: pointer;
|
|
}
|
|
|
|
h1,
|
|
h2,
|
|
h3,
|
|
h4,
|
|
h5,
|
|
h6,
|
|
#toctitle {
|
|
position: relative;
|
|
margin-top: 1.5em;
|
|
margin-bottom: 0.25em;
|
|
|
|
+ table,
|
|
+ .table-wrapper,
|
|
+ .code-example,
|
|
+ .highlighter-rouge,
|
|
+ .sectionbody .listingblock {
|
|
margin-top: 1em;
|
|
}
|
|
|
|
+ p {
|
|
margin-top: 0;
|
|
}
|
|
}
|
|
|
|
> h1:first-child,
|
|
> h2:first-child,
|
|
> h3:first-child,
|
|
> h4:first-child,
|
|
> h5:first-child,
|
|
> h6:first-child,
|
|
> .sect1:first-child > h2,
|
|
> .sect2:first-child > h3,
|
|
> .sect3:first-child > h4,
|
|
> .sect4:first-child > h5,
|
|
> .sect5:first-child > h6 {
|
|
margin-top: $sp-2;
|
|
}
|
|
}
|