Skip to content
Snippets Groups Projects
  1. Feb 05, 2023
    • Christian Bäuerlein's avatar
      Add configuration key to load a local version of mermaid (#1153) · b2bbdb70
      Christian Bäuerlein authored
      Hi there!
      
      Thank you for the great theme! I am a happy user and was delighted to see that mermaid support has landed.
      
      In some cases the usage of jsDelivr might not be possible for technical or compliance reasons.
      
      This commit adds a second way to include the mermaid lib by specifying a path in the mermaid config. This way a local version of the lib can be used.
      
      It should be fully backwards compatible, not requiring any action by users that already include the lib from the CDN.
      
      I already added some documentation, but I am also happy to extend this, if this change is generally well-received.
      
      Cheers,
      Christian
      Unverified
      b2bbdb70
  2. Jan 30, 2023
    • Matt Wang's avatar
      docs: label new features introduced in `v0.4` (#1138) · 5f91e326
      Matt Wang authored
      In #1058, I noted:
      
      > Tangentially related work:
      > ...
      > - better annotate new features (motivated by writing these docs)
      >     - we should add "New" to new features :) 
      >     - we should note when a feature was introduced (I think this is a core part of most software documentation)
      >     - we should annotate things that are "Advanced" in so far as the average Just the Docs user will not use them / they require significant Jekyll knowledge
      > 
      
      This came up again in https://github.com/just-the-docs/just-the-docs/discussions/1136#discussioncomment-4716253, so I think it's best for us to resolve this sooner rather than later.
      
      This PR is me doing that. I:
      
      - have added a headings-level "New" label to every new heading introduced since `v0.3`
      - added, when possible, inline YAML comments when new configuration options have been introduced
      
      I did this by scanning through the CHANGELOG and selecting each feature that is either tagged with `Add` and has documentation.
      
      I may have also missed any new features, so some double-checking would be helpful!
      Unverified
      5f91e326
  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 13, 2023
    • Matt Wang's avatar
      docs: fix broken relative page links (#1106) · a789198b
      Matt Wang authored
      In touching up the migration guide, I noticed that many of our documentation site links are broken! For example, on the homepage, this link:
      
      <img width="782" alt="screenshot of homepage; code snippet is in next block" src="https://user-images.githubusercontent.com/14893287/210462690-31aa7bf5-dd79-4e8f-a3c5-1213e73771c4.png">
      
      which has the following href
      
      ```code
      <a href="/just-the-docs/just-the-docs/CHANGELOG/">the CHANGELOG</a>
      ```
      
      duplicates the `baseurl` twice. There are 14 such broken links across the site. Each link duplicates the `baseurl` and `link` tags, which has since been resolved with links being relative by default (there's a set of PRs that document this - I can't find the exact paper trail right now).
      
      To resolve this, I:
      
      - find and replace site-wide `{{ site.baseurl }}{% link` with `{% link`
      - tested each link, which now works properly locally *and* on the deploy preview
      
      I'm surprised we didn't catch this earlier! I also could be missing something else, in which case feedback on this PR is certainly welcome.
      Unverified
      a789198b
  5. Dec 27, 2022
    • Peter Mosses's avatar
      Restore simple configuration of favicon.ico (#1095) · 7cabda29
      Peter Mosses authored
      Avoid the need to add a link to favicon,ico when editing `_includes/head_custom.html`, and avoid creating an invalid favicon link
      
      - Remove the content of `_includes/head_custom.html`
      - Add code to `_includes/head.html` to create a link to an existing favicon,ico
      - Add an explanation of favicon_ico to docs/configuration.md
      - Remove the example of `includes/head_custom.html` and add an explanation of what the `<head>` element automatically includes
      Unverified
      7cabda29
    • Flo's avatar
      docs(collections): Add warning about mandatory `_`-prefix (#1091) · 0b44f5ba
      Flo authored
      * docs(collections): Add warning about mandatory `_`-prefix
      
      * Apply recommended wording
      Unverified
      0b44f5ba
  6. Dec 18, 2022
    • Michelle Blanchette's avatar
      analytics: support multiple tracking IDs, document UA -> GA4 switch (#1029) · 9bccf07f
      Michelle Blanchette authored
      * Issue #1023 - note that GA4 properties are supported
      
      * Issue #1023 - parameterize Google Analytics property script
      
      * Issue #1023 - support a list of multiple Google Analytics tracking IDs in config
      
      * Issue #1023 - update Google Analytics configuration doc
      
      * Fix configuration of multiple Google Analytics properties and simplify type checking
      
      * simplify unnecessary code repetition
      
      * tweak Google Analytics config documentation wording
      Unverified
      9bccf07f
  7. Aug 12, 2022
    • Matt Wang's avatar
      `mermaid`: refactor config to use `mermaid_config.js` include, only require... · e2f1546c
      Matt Wang authored
      `mermaid`: refactor config to use `mermaid_config.js` include, only require `mermaid.version` in `_config.yml` (#909)
      
      This PR has a bit of scope creep! This PR now:
      
      - changes the mermaid opt-in logic to only check for the existence of a `mermaid` key instead of `mermaid != false`: this resolves the follow-up in #857
      - changes the behaviour of mermaid configuration
          - instead of using `mermaid_init.html` with default settings, makes the include `mermaid_config.js`
          - the include is loaded directly into the contents of `mermaid_initialize`
          - by default, it is an empty object (i.e. `{}`), triggering the defaults
      - updates docs
      - adds an example to the markdown kitchen sink  
      
      It does significantly change the interface provided in #857, and I apologize for the confusion. However, given the discussion in this PR, I think it's the best move forward!
      Unverified
      e2f1546c
  8. Jul 13, 2022
  9. Jul 12, 2022
  10. Jul 04, 2022
  11. Mar 03, 2022
  12. Jun 18, 2021
  13. Oct 13, 2020
  14. Oct 12, 2020
  15. Sep 14, 2020
  16. Aug 26, 2020
  17. Jul 25, 2020
  18. Jul 10, 2020
  19. Jul 09, 2020
  20. Jun 25, 2020
  21. Apr 24, 2020
  22. Mar 24, 2020
  23. Jan 12, 2020
  24. Jan 02, 2020
  25. Dec 29, 2019
  26. Nov 27, 2019
  27. Nov 12, 2019
    • Alexey Averikhin's avatar
      Enable IP anonymization in Google Analytics (GDPR) · 25331a5f
      Alexey Averikhin authored
      - Introduced "ga_tracking_anonymize_ip" parameter to enable/disable Google Analytics IP anonymization (to comply with GDPR).
      
      (cherry picked from commit ce530f36fa0549c78ffe53ea6077f44f6f0b330f) (+1 squashed commit)
      Squashed commits:
      [69b7718] - enable GA anonymize_ip
      
      (cherry picked from commit f2b67c632af72b61dd634b9a337200781519691e)
      25331a5f
  28. Oct 02, 2019
  29. Sep 11, 2019
Loading