Skip to content
Snippets Groups Projects
  1. 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
  2. Dec 27, 2022
  3. Aug 22, 2022
  4. 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
  5. Jul 12, 2022
  6. Aug 10, 2020
  7. May 01, 2020
  8. Jan 14, 2019
  9. Nov 16, 2018
  10. Mar 27, 2017
  11. Mar 24, 2017
  12. Mar 09, 2017
Loading