35 Commits

Author SHA1 Message Date
Christian Bäuerlein
b2bbdb7040
Add configuration key to load a local version of mermaid (#1153)
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
2023-02-05 14:51:48 -08:00
Peter Mosses
7cabda2983
Restore simple configuration of favicon.ico (#1095)
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
2022-12-27 13:09:47 -08:00
Michelle Blanchette
9bccf07faa
analytics: support multiple tracking IDs, document UA -> GA4 switch (#1029)
* 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
2022-12-17 23:43:55 -08:00
Matt Wang
845cd763f3
Removes favicon.html, shifts content to head_custom.html (#1027)
* Removes `favicon.html`, shifts content to `head_custom.html`
* explicit callout for custom favicon in customization docs
* Cleaner and more consistent documentation (review from @pdmosses)

Co-authored-by: Peter Mosses <18308236+pdmosses@users.noreply.github.com>
2022-12-13 11:21:20 -08:00
Tom Brouwer
c498a5690a
Fix duplicate title if jekyll-seo-tag not in users's plugins (#1040)
In case 'just-the-docs' is used as a theme, and a user does not
eplicitly include 'jekyll-seo-tag' inside the plugins list in
_config.yml, two 'title' elements were rendered. Since
jekyll-seo-tag is always available, because it's set in the plugins
list of the theme itself, the 'seo' tag will aways work, making
the seperate title and description elements obsolete.

Fixes #1008
2022-11-15 00:09:59 -08:00
Matt Wang
855427186b
Fix HTML validation issues (W3C validator) (#964)
Closes #963.

- redundant `role="navigation"` on nav elements
- redundant `type="text/javascript"` on script tags
- misplaced mermaid script tag

Note that [running the validator on the deploy preview](https://validator.w3.org/nu/?doc=https%3A%2F%2Fdeploy-preview-964--just-the-docs.netlify.app%2F) has no errors now!
2022-09-15 12:24:26 -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
Ilya Ivanov
9e52e712ae allow custom favicon code 2020-10-13 05:29:25 +07:00
marksie1988
e181626b66 merge upstream 2020-06-26 11:50:56 +01:00
marksie1988
d7050b3f04 change to relative_url 2020-06-26 10:08:11 +01:00
Patrick Marsceill
59d4802ce3
Merge branch 'improvement/custom-themes' of git://github.com/SgtSilvio/just-the-docs into SgtSilvio-improvement/custom-themes 2020-04-24 15:39:44 -04:00
Patrick Marsceill
0716ea77d6
Merge pull request #250 from Labs64/pr-anonymize_ip
Enable IP anonymization in Google Analytics (GDPR)
2020-04-24 14:47:21 -04:00
R.Brown
17cf72bd33
Update _includes/head.html
Co-Authored-By: Patrick Marsceill <pmarsceill@users.noreply.github.com>
2020-04-24 19:44:25 +02:00
Serge
aa8ca74883
Fix duplicated title and description tags
Currently just-the-docs renders two title and description tags
when used with jekyll-seo-tag. This patch fixes plugin detection
conditonal.
2020-03-22 22:51:37 -04:00
Alexey Averikhin
25331a5ffa Enable IP anonymization in Google Analytics (GDPR)
- 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)
2019-11-12 10:27:01 +01:00
Silvio Giebl
95498ccaf8 Added just-the-docs-default.scss which includes the theme set in _config.yml 2019-08-17 15:02:53 +02:00
Silvio Giebl
f61b836f6e Fixed stylesheet link
(cherry picked from commit ac42a41ae3e36b002df52882be296c01873c0e5b)
2019-08-15 18:35:59 +02:00
Silvio Giebl
cba53a6914 Make themes more customizable
(cherry picked from commit dffb2706a158784e2f3091f895a868e373683bc8)
2019-08-15 18:35:10 +02:00
Patrick Marsceill
d01f0e29db
Make search on by default 2019-08-14 16:43:59 -04:00
Patrick Marsceill
1a2636350f
Merge branch 'v0.2.6-release' into improve-search 2019-08-14 10:43:59 -04:00
Patrick Marsceill
3ad99afb02
Merge branch 'v0.2.6-release' into update-analytics-to-gtag 2019-08-13 11:12:15 -04:00
Adam Green
aa0d8f1d40 Modified the google analytics code to match the new tags used by GA 2019-07-24 09:35:13 -04:00
hallowf
2d1babc452 Replaced old script for analytics with gtag 2019-07-04 15:52:01 +01:00
Silvio Giebl
0142d2874b Enabled customization of html head 2019-05-19 02:55:43 +02:00
Silvio Giebl
b3f52fedad Added html compression 2019-05-19 02:55:43 +02:00
Patrick Marsceill
460e9ae236
No title if SEO is enbaled 2019-05-13 16:40:28 -04:00
gebeto
25b6455ed7 add seo 2019-02-28 08:10:48 +02:00
Patrick Marsceill
aee6d1fb8c
Use analytics.js instead of tag manager 2019-02-02 13:59:41 -08:00
Patrick Marsceill
e12408d07b
Add hook for GA tracking 2019-02-02 12:32:04 -08:00
Patrick Marsceill
f264034999
If page has a description use that for meta data 2019-01-06 15:48:58 -05:00
Patrick Marsceill
d11e332dc6
Create condition for no search and add config/css 2018-11-16 11:46:43 -05:00
Patrick Marsceill
2aaff540a1
Fix assets 2018-10-22 17:17:46 -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