Commit Graph

112 Commits

Author SHA1 Message Date
Simone ce3f34bbc7 Add copy code button to code snippets (#945)
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:


![image](https://user-images.githubusercontent.com/26844016/187731472-d4bf7828-2356-4d94-9c2d-9db863228f5f.png)

to avoid this:

![image](https://user-images.githubusercontent.com/26844016/183292313-d7f73d7d-58c0-4c7b-b5ba-e08bd285514b.png)

Co-authored-by: Matt Wang <matt@matthewwang.me>
2022-12-26 16:45:37 -08:00
Matt Wang 197d18d8b4 vendor: update jekyll-anchor-headings, lunr.js (#1071)
Closes #1070.

This PR:

- updates `jekyll-anchor-headings` to `1.0.12`; this was a simple copy-paste
- updates `lunr.js` to `2.3.9`; this was a bit more involved:
    - I didn't see a minified build in the repo, so I ran it through [DigitalOcean's minifier](https://www.digitalocean.com/community/tools/minify)
    - copyright notices weren't properly included in the previous minified build, so I:
        - include an actual copy of the original MIT License for `lunr.js`
        - includes proper attribution for other functions, which include derivative works

There's a tiny bundle size increase in `lunr.js` due to the comments, but I think that's reasonable given that it's related to licensing; still trivial in the grand scheme of things.

As an aside: it would be neat if we could include minification as part of the build pipeline instead!
2022-12-21 14:19:29 -08:00
Peter Mosses 672c284b6f Fix nav scroll feature (#898)
The nav scroll feature had stopped working (altogether),
due to the change from absolute to relative urls.

This update uses the document location pathname as the `href`.
It appears to work locally.
2022-08-02 22:31:17 -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
Doug Aitken 37e90d2676 change small-image
Changed small-image to match large image and fix reference
2022-03-06 12:20:58 +00:00
Doug Aitken 655335d552 Rename large file and fix reference
Renaming the large image and changed the index test references to display these images
2022-03-06 12:04:39 +00:00
Doug Aitken ee47119f31 Adding large image for index text
Remote image here is not loading - https://just-the-docs.github.io/just-the-docs/docs/index-test/#large-image

via https://www.flickr.com/photos/97810305@N08/9401451269
2022-03-06 11:53:01 +00:00
Silvio Giebl 6b27beaf58 Added just-the-docs.collections nav_exclude and search_exclude
Renamed doc_collections to just-the-docs.collections
2020-07-10 19:07:01 +02:00
Silvio Giebl d1c3e08337 Updated doc_collections format 2020-07-09 23:33:52 +02:00
Silvio Giebl 93f93f48a7 Added doc collections and categories 2020-07-09 21:07:24 +02:00
Silvio Giebl 1cf7d5aba9 Restored search.rake 2020-06-18 22:39:58 +02:00
Silvio Giebl 51f15965f2 Merge branch 'feature/search-sections' into improvement/navigation-new
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
#	assets/js/search-data.json
#	docs/configuration.md
#	lib/tasks/search.rake
2020-06-15 22:06:16 +02:00
Silvio Giebl 16628f2b8e Improved search responsiveness for many results 2020-06-15 21:57:55 +02:00
Silvio Giebl b7a5458375 Fixed fuzzy search hangs for long words 2020-06-15 21:57:55 +02:00
Silvio Giebl da9276121a Improved search input for mobile
- font size 16px to prevent zooming on iOS Safari
- search input is scrolled into view on iOS Safari
- box-shadow is displayed correctly
2020-06-15 21:57:54 +02:00
Silvio Giebl 18f3a41600 Merge branch 'bugfix/page-scrolling' into improvement/navigation-new
# Conflicts:
#	_layouts/default.html
#	assets/js/just-the-docs.js
2020-06-15 21:44:30 +02:00
Silvio Giebl e216623ed3 Merge branch 'improvement/search-button' into improvement/navigation-new 2020-06-15 21:37:31 +02:00
Silvio Giebl c7466e88a8 Merge branch 'improvement/navigation' into improvement/navigation-new
# Conflicts:
#	_includes/nav.html
#	_layouts/default.html
2020-06-15 21:23:03 +02:00
Patrick Marsceill 798c14b46a lint 2020-05-21 14:15:14 -04:00
Patrick Marsceill 955ac23149 Rm preview js 2020-04-24 15:41:13 -04: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
pmarsceill c818624363 🎨 Prettier 2020-04-24 15:44:37 +00:00
Silvio Giebl e2e01effa6 Add fuzzy search if no results were found 2020-01-03 22:44:04 +01:00
Silvio Giebl 19e35329d2 Fixed search result word wrap 2020-01-02 14:32:51 +01:00
Silvio Giebl 757742e79c Fixed search result word wrap 2020-01-02 14:20:09 +01:00
Silvio Giebl f1c306c814 Multi search match highlight
Added multiple previews, configurable by site.search.previews
Improved search-data.json
2020-01-02 11:55:38 +01:00
Silvio Giebl 74681aeb21 Improved js function nesting 2020-01-01 16:50:31 +01:00
Silvio Giebl c907e79251 Improved padding of active search input 2020-01-01 00:21:19 +01:00
Silvio Giebl 82b3f15443 Added search.button configuration
Improved documentation for search configurations
2019-12-29 21:30:44 +01:00
Silvio Giebl ff30552748 Moved config search_tokenizer_separator -> search.tokenizer_separator 2019-12-29 20:08:34 +01:00
Silvio Giebl 7f5b1f14f1 Search for sections (configurable via search.heading_level)
Added more search configurations
Display "no results found"
2019-12-29 19:19:00 +01:00
Silvio Giebl a6f2ed8c6c Improved search on mobile 2019-12-04 22:27:43 +01:00
Silvio Giebl 1d1564e5c0 Improved search layout: scrolling, mobile 2019-12-04 10:39:30 +01:00
Silvio Giebl 804cad6c4d Improved search interface 2019-12-03 09:12:54 +01:00
Silvio Giebl d66ebdec4b Improved showing/hiding search results on focus/blur 2019-12-01 16:26:23 +01:00
Silvio Giebl 0c9678c2e6 Fix search issues 2019-11-30 17:35:09 +01:00
Silvio Giebl 73047a078f Scroll page instead of nested div, removed nested divs 2019-11-27 22:07:22 +01:00
Silvio Giebl 03979bf8fc Added documentation for custom color schemes and custom css 2019-11-27 11:15:57 +01:00
Silvio Giebl 301a4ab644 Merge branch 'improvement/navigation-merged' into improvement/search-button-merged
# Conflicts:
#	_layouts/default.html
2019-11-26 23:33:18 +01:00
Silvio Giebl fd91140923 Merge branch 'master2' into improvement/navigation-merged
# Conflicts:
#	_layouts/default.html
2019-11-26 23:30:46 +01:00
Silvio Giebl bb0e5222ca Merge branch 'master2' into improvement-custom-themes-merged 2019-11-26 23:27:33 +01:00
Patrick Marsceill 95bdc51a0a Update dark-mode-preview.js 2019-09-10 11:20:26 -04:00
Patrick Marsceill ff106641b0 syntax error 2019-09-09 16:09:05 -04:00
Patrick Marsceill dbac62127a Merge branch 'v0.2.7-release' into change-theme-button-text 2019-09-09 16:06:21 -04:00
Patrick Marsceill 850a8fe256 Merge pull request #203 from pdmosses/search-config
Search config
2019-09-09 16:00:11 -04:00
Patrick Marsceill 9616dcf761 Update just-the-docs.js 2019-09-09 15:50:48 -04:00
Patrick Marsceill 3b42ec2762 Merge pull request #206 from iamcarrico/allow-for-overrides
Allow for custom overrides by the user
2019-09-09 15:35:31 -04:00
Patrick Marsceill 3ecdb59b48 Merge branch 'v0.2.7-release' into patch-1 2019-09-09 15:32:08 -04:00
Ian Carrico 47b7991805 Allow for custom overrides by the user 2019-09-04 08:55:11 -04:00
Peter Mosses 50cdf076b4 Add configuration option search_tokenizer_separator
The default is for hyphens to separate tokens in search terms: `gem-based` is equivalent to `gem based`.

This adds `search_tokenizer_separator` as a site configuation option, to support search for hyphenated words.
2019-08-29 15:36:13 +02:00