Skip to content
Snippets Groups Projects
  1. Jun 11, 2024
  2. Jan 30, 2023
  3. Jan 18, 2023
    • Matt Wang's avatar
      Add new `_sass/custom/setup.scss` for variable definition (#1135) · d423c96d
      Matt Wang authored
      
      This is an alternative PR that resolves #1011. Unlike #1013, this PR defines a *new* SASS file, `_sass/custom/setup.scss`, specifically designed for new custom variables (and other SASS-only constructs). It's imported after our `support` SASS files are (functions, variables), but otherwise is imported before all other files (ex, when CSS is emitted).
      
      So, custom callout colors can now be defined in this file. I also move the custom callout colors present in `custom.scss` to the right location.
      
      I've added some docs that briefly explain how to use the feature. Feedback is welcome!
      
      ---
      
      As an aside, I chose not to add a `_includes/css` file that imports this, and then import that file. I think that's only necessary if we're trying to render liquid somehow in the SASS file; since we're not trying to do that for `setup.scss`, I've opted to not include it. If we think this is relevant, I can re-add it.
      
      Co-authored-by: default avatarPeter Mosses <18308236+pdmosses@users.noreply.github.com>
      Unverified
      d423c96d
  4. Jan 10, 2023
  5. Jan 09, 2023
    • Kevin Lin's avatar
      Fix incorrect `padding` property value pair in `search.scss` (#1123) · 2691ff8a
      Kevin Lin authored
      This PR corrects the change to `/_sass/search.scss` made in 551398f9. This change tried to set the `padding-**top**` property to **two** values rather than set the `padding` property to these values (to represent the vertical and horizontal padding values).
      
      I just reviewed 551398f9 and believe that this should be the other half of the fix proposed by just-the-docs/just-the-docs#1104.
      Unverified
      2691ff8a
  6. Jan 03, 2023
  7. Dec 31, 2022
  8. Dec 27, 2022
  9. Dec 22, 2022
  10. Dec 21, 2022
  11. Sep 27, 2022
    • Peter Mosses's avatar
      Improve docs for code highlighting with line numbers (#974) · 93857587
      Peter Mosses authored
      * Add toc heading custom include
      
      Closes #961.
      
      * Revert "Add toc heading custom include"
      
      This reverts commit 49813c341973e313db0a21f075a60ebf2120989e.
      
      * Update code highlighting with line numbers
      
      - Add the example of code highlighting with line numbers explained in the [Jekyll docs](https://jekyllrb.com/docs/liquid/tags/#line-numbers).
      - Fix the styling of narrow code with line numbers, which floats to the centre without this CSS adjustment. (The line numbers column expands as needed with larger numbers of lines, despite using `width`; using `min-width` doesn't work.)
      
      To apply HTML compression, I removed `vendor` from `exclude`; that change is left to a different PR.
      Unverified
      93857587
  12. Sep 22, 2022
  13. Sep 16, 2022
  14. Sep 11, 2022
  15. Sep 07, 2022
    • Alyssa Ross's avatar
      Improve display of AsciiDoc examples with titles (#944) · e03483d8
      Alyssa Ross authored
      
      The jekyll-asciidoc plugin will take AsciiDoc markup like this:
      
      	.A method that returns the string "Hello, world"
      	[example]
      	[source,ruby]
      	----
      	def hello
      	  "Hello, world"
      	end
      	----
      
      And produce HTML like this (syntax highlighting disabled):
      
      	<div class="listingblock">
      	  <div class="title">A method that returns the string "Hello, world"</div>
      	  <div class="content">
      	    <pre class="highlight"><code class="language-ruby" data-lang="ruby">def hello
      	  "Hello, world"
      	end</code></pre>
      	  </div>
      	</div>
      
      Previously, because we were applying code block styling to the whole
      listingblock, the title would be rendered as normal body text, inside
      the code block, which did not look good.  With this change, it will
      instead be rendered similarly to a Just The Docs rendered example —
      the title will appear where the rendered example usually would.
      
      Co-authored-by: default avatarMatt Wang <matt@matthewwang.me>
      Unverified
      e03483d8
  16. Aug 01, 2022
  17. Jul 26, 2022
  18. Jul 25, 2022
    • Matt Wang's avatar
      Update Stylelint to v14, extend SCSS plugins, remove primer-* configs, resolve issues (#821) · c2ec3d89
      Matt Wang authored
      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?~~
      Unverified
      c2ec3d89
  19. Jul 23, 2022
  20. Jul 21, 2022
  21. Jul 13, 2022
  22. Jul 12, 2022
    • nascosto's avatar
      Add mermaid support (#857) · 6907f069
      nascosto authored
      
      Closes #825
      
      
      Co-authored-by: default avatarMatt Wang <matt@matthewwang.me>
      Unverified
      6907f069
    • Alyssa Ross's avatar
      Minor style fixes for jekyll-asciidoc (#829) · 3ca57e3b
      Alyssa Ross authored
      I have a site whose content is written in AsciiDoc, using the [jekyll-asciidoc][] plugin.
      
      Just the Docs works great, but there are just two minor styling glitches I've noticed:
      
      The first is that Just the Docs' CSS doesn't understand the code block markup jekyll-asciidoc produces.  It's not too different though, so it's very easily fixed.
      
      The second is that jekyll-asciidoc generates `div.sect(𝑛 − 1)` elements around headings of type `h𝑛`, that enclose all the heading and all the content after it until the next heading of greater or equal rank.
      
      This means that headings are _always_ first children in AsciiDoc output, which meant the wrong margins were applied to most headings. To fix this, we need to only reduce the margin of first-child headings nested directly below the .main-content element, and headings nested directly below AsciiDoc `.sect𝑛` elements that are themselves first children.
      
      With these two small changes, my site looks perfect, and the styles look exactly the same as on Just the Docs' own documentation.
      
      [jekyll-asciidoc]: https://github.com/asciidoctor/jekyll-asciidoc
      Unverified
      3ca57e3b
  23. Jul 05, 2022
  24. Jul 04, 2022
  25. Mar 09, 2022
  26. Mar 01, 2022
  27. Jun 18, 2021
Loading