- Feb 05, 2023
-
-
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
-
- Jan 30, 2023
-
-
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!
-
- Jan 13, 2023
-
-
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.
-
- Jan 11, 2023
-
-
Adam Gabryś authored
The typography utilities page has been moved sopme time ago, but the button URL was not updated. This commit fixes the broken link.
-
- Dec 27, 2022
-
-
Simone authored
Hello everyone, this is my implementation for the copy button on the snippet (requested in #924) The implementation is made 100% javascript as with or without a jekyll template modification you still have to execute some javascript code, and I consider it the best choice. the button only appears if the mouse is over it, to allow the entire line to be read the important CSS changes were made to make the copy button work even in the long code situation:  to avoid this:  Co-authored-by:
Matt Wang <matt@matthewwang.me>
-
- Sep 27, 2022
-
-
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.
-
- Sep 11, 2022
-
-
Peter Mosses authored
This PR updates the home page and the CHANGELOG to refer to v0.4.0.rc1 as a pre-release or release candidate, rather than a release. See [this comment](https://github.com/just-the-docs/just-the-docs/pull/613#issuecomment-1240442518) for motivation. It also adds the versioned docs issue (#728) to the roadmap in the CHANGELOG. As the config for the theme docs now needs to declare callouts, the [callouts docs](https://just-the-docs.github.io/just-the-docs/docs/ui-components/callouts/) can now illustrate the rendered appearance. (These callouts are merely examples: the names and colors should eventually be replaced by a principled collection, taking account of WCAG.)
-
- Aug 22, 2022
-
-
Matt Wang authored
Short and sweet PR that addresses the follow-up in #909: enabling `mermaid` on our docs site, but making it clear that users still need to opt-in to use it. I've also added an example in-action. To test: [see the Netlify deploy](https://deploy-preview-935--just-the-docs.netlify.app/docs/ui-components/code/#mermaid-diagram-code-blocks).
-
- Aug 12, 2022
-
-
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!
-
- Jul 12, 2022
-
-
nascosto authored
Closes #825 Co-authored-by:
Matt Wang <matt@matthewwang.me>
-
- Jul 04, 2022
-
-
Peter Mosses authored
This PR combines (and resolves conflicts between) #448, #463, #466, #494, #495, #496, #498, and #572. The main aim is to facilitate use of several of the implemented features _together_, when using the fork as a remote theme. It should also simplify merging the included PRs into a future release. The branch [combination-rec-nav](https://github.com/pdmosses/just-the-docs/tree/combination-rec-nav) adds [multi-level navigation](https://github.com/pmarsceill/just-the-docs/pull/462) and (NEW:) [sibling links](https://github.com/pmarsceill/just-the-docs/pull/394) to the branch used for this PR. It includes updated [documentation for the navigation structure](https://pdmosses.github.io/just-the-docs/docs/navigation-structure/), and reorganised and extended [navigation tests](https://pdmosses.github.io/just-the-docs/tests/navigation/). The documentation and the tests can be browsed at the (temporary) [website published from the combination-rec-nav branch](https://pdmosses.github.io/just-the-docs/ ). _Caveat:_ The changes to v0.3.3 in this PR and #462 have not yet been reviewed or approved, and may need updating before merging into a release of the theme. If you use a branch from a PR as a remote theme, there is a risk of such updates affecting your website. Moreover, these branches are likely to be deleted after they have been merged. To avoid such problems, you could copy the branch that you want to use to your own fork of the theme. Co-authored-by:
Matt Wang <matt@matthewwang.me>
-
- Mar 09, 2022
-
-
Michelle Blanchette authored
Co-authored-by:
Matt Wang <matt@matthewwang.me>
-
- Jun 18, 2021
-
-
Cassandra Gould van Praag authored
-
- Sep 14, 2020
-
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
- Sep 11, 2020
-
-
PLanCompS authored
doc for turning on kramdown linenos globally corrected/
-
- Aug 10, 2020
-
-
PLanCompS authored
-
- Jun 27, 2020
-
-
Henrique Vianna authored
Updated native font stack, as suggested in https://github.com/pmarsceill/just-the-docs/issues/330#issuecomment-650415240
-
- Jun 01, 2020
-
-
Henrique Vianna authored
-
- May 01, 2020
-
-
Patrick Marsceill authored
-
- Jan 14, 2019
-
-
EricFromCanada authored
For pages in utilities/, reorder `nav_order` to follow `parent`.
-
EricFromCanada authored
-
EricFromCanada authored
-
- Nov 19, 2018
-
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
- Nov 16, 2018
-
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
Patrick Marsceill authored
-
- Oct 23, 2018
-
-
Patrick Marsceill authored
-
- Jun 04, 2017
-
-
Patrick Marsceill authored
-
- Mar 27, 2017
-
-
Patrick Marsceill authored
-
- Mar 24, 2017
-
-
Patrick Marsceill authored
-
- Mar 09, 2017
-
-
Patrick Marsceill authored
-