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 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
  4. Jan 11, 2023
  5. Dec 27, 2022
  6. 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
  7. Sep 11, 2022
  8. Aug 22, 2022
  9. 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
  10. Jul 12, 2022
  11. Jul 04, 2022
  12. Mar 09, 2022
  13. Jun 18, 2021
  14. Sep 14, 2020
  15. Sep 11, 2020
  16. Aug 10, 2020
  17. Jun 27, 2020
  18. Jun 01, 2020
  19. May 01, 2020
  20. Jan 14, 2019
  21. Nov 19, 2018
  22. Nov 16, 2018
  23. Oct 23, 2018
  24. Jun 04, 2017
  25. Mar 27, 2017
  26. Mar 24, 2017
  27. Mar 09, 2017
Loading