steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-09-13 05:13:33 -06:00
Code Issues Packages Projects Releases Wiki Activity
1,088 Commits 8 Branches 50 Tags
e88f7f325ff772c1adafebe8464081c07e0270ea
Commit Graph

32 Commits

Author SHA1 Message Date
Peter Mosses
bd2af37865 Clarify version docs (#955) 
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.)
 2022-09-10 16:44:27 -07:00
Matt Wang
011f783fc7 enables mermaid in docs (#935) 
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).
 2022-08-21 16:32:27 -07:00
Matt Wang
e2f1546c61 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!
 2022-08-11 19:34:15 -07:00
nascosto
6907f06977 Add mermaid support (#857) 
Closes #825


Co-authored-by: Matt Wang <matt@matthewwang.me>
 2022-07-12 15:16:18 -07:00
Peter Mosses
70b34f01f7 Combination (#578) 
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>
 2022-07-04 12:15:10 -07:00
Michelle Blanchette
260d98d825 remove extra spaces (#554) 
Co-authored-by: Matt Wang <matt@matthewwang.me>
 2022-03-09 10:36:09 -08:00
Patrick Marsceill
1f30d6bf78 Update line-nos.md 2020-09-14 13:29:09 -04:00
Patrick Marsceill
916a9256b1 Forgot this too 2020-09-14 13:24:10 -04:00
Patrick Marsceill
84e67c34b7 Forgot to remove this 2020-09-14 13:19:33 -04:00
Patrick Marsceill
1b0a313c16 Make examples more clear 2020-09-14 12:54:55 -04:00
Patrick Marsceill
c587c0b217 Fix heading hierarchy 2020-09-14 12:46:26 -04:00
Patrick Marsceill
e4246b35b0 Update permalink 2020-09-14 12:43:59 -04:00
PLanCompS
d59887cc2b Update linenos.md 
doc for turning on kramdown linenos globally corrected/
 2020-09-11 19:42:44 +02:00
Patrick Marsceill
322026633f Merge pull request #331 from hvianna/master 
Fix native font stack precedence issue on Windows systems.
 2020-09-11 11:48:54 -04:00
PLanCompS
74da664c0a Linenos test moved to UI Components as a child of Code 2020-08-10 16:53:48 +02:00
Henrique Vianna
72b6de8862 Updated native font stack, as suggested in https://github.com/pmarsceill/just-the-docs/issues/330#issuecomment-650415240 2020-06-27 17:37:39 -03:00
Henrique Vianna
1f492b68f3 Merge remote-tracking branch 'upstream/master' 2020-06-27 17:34:59 -03:00
Henrique Vianna
7cfc63e138 Fix native font stack precedence issue on Windows systems. 2020-06-01 14:35:15 -03:00
Patrick Marsceill
2f13db1f01 Make code font size dynamic 2020-05-01 15:07:27 -04:00
EricFromCanada
2218e6e565 Fix links and syntax 
For pages in utilities/, reorder `nav_order` to follow `parent`.
 2019-01-14 14:43:33 -05:00
EricFromCanada
ae5bcfe361 Fix grammar and capitalization 2019-01-14 14:43:29 -05:00
EricFromCanada
ff49d02f83 Make spacing consistent 2019-01-14 14:43:16 -05:00
Patrick Marsceill
3ecef3be5c jk 2018-11-19 13:37:49 -05:00
Patrick Marsceill
960d347f68 Support 3 levels of pages 2018-11-19 13:28:59 -05:00
Patrick Marsceill
410085dd28 Content cleanup 2018-11-16 14:37:00 -05:00
Patrick Marsceill
e41c1701a5 Bump nav order for new docs 2018-11-16 11:47:14 -05:00
Patrick Marsceill
45eea0efb6 Add docs for lists 2018-11-16 10:57:07 -05:00
Patrick Marsceill
bf0d7eaa5f Fix moar paths 2018-10-23 16:45:08 -04:00
Patrick Marsceill
76d8f0c50c I forget 2017-06-04 17:50:01 -04:00
Patrick Marsceill
e581397758 Initial commit 2017-03-26 21:09:19 -04:00
Patrick Marsceill
594385ae7b initial commit 2017-03-24 09:47:37 -04:00
Patrick Marsceill
b7b0d0d7bf Initial commit 2017-03-09 13:16:08 -05:00