Commit Graph

39 Commits

Author SHA1 Message Date
Matt Wang 2dd535c2da Fix: protect search-data.json file from front matter default for layout (#1468)
Fixes #1466. Prior art: #1447. Otherwise self-explanatory.

To test:

1. First, clone [template repository](https://github.com/just-the-docs/just-the-docs-template/tree/main). Observe that search works.
2. Next, add a default layout to all files
```yml
defaults:
  - scope:
      path: ""
    values:
      layout: "default"
```
3. Observe that search no longer works.
4. Apply this patch
5. Observe that search works again!
2024-05-15 17:06:27 -07:00
Dale Phurrough 7a01ef1a59 add options for custom lunr Liquid and JS code (#1068)
This is a prototype for review and discussion. My use and testing of this PR is on top of 6d9d41359c. The changes are trival to rebase to `main` and I'm happy to do so if this prototype moves forward.


* Feature request details in linked issue, fixes just-the-docs/just-the-docs#1067
* I welcome feedback and all discussion
* A draft doc site of mine using this PR is at https://docs.hidale.com/

To use the prototype, the two include files need to be customized. Here are mine from the draft website https://github.com/diablodale/dp.docs/commit/9c0d836408af2e72dbce115a01ce6627137e66dd

Co-authored-by: Matt Wang <matt@matthewwang.me>
2023-01-13 19:08:33 -08: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
Patrick Marsceill 6be8a2e38a Merge pull request #379 from SgtSilvio/feature/doc-collections
Feature/doc collections
2020-08-10 10:42:30 -04: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 d476ce5748 Updated search.rake 2020-07-09 22:14:57 +02:00
marksie1988 d3d17c0460 fix conflicts 2020-06-27 10:02:36 +01:00
marksie1988 e181626b66 merge upstream 2020-06-26 11:50:56 +01:00
marksie1988 88759c1cf7 change to relative_url 2020-06-26 11:41:50 +01:00
Silvio Giebl 1cf7d5aba9 Restored search.rake 2020-06-18 22:39:58 +02:00
Arthur Brugière 34ed214ef6 [SEARCH RAKE] Fix search generator 2020-05-13 14:45:38 +07:00
Silvio Giebl f5e6573e16 Removed unnecessary rake command and files
Improved search documentation
2020-03-25 00:23:17 +01:00
websTTer d3e97d31fa Update
duplicated from fix #80 
the same error in Version 2.0.7
fix with same procedure
2019-09-12 08:30:29 +02:00
Patrick Marsceill 01a3c35c98 Update search.rake 2019-09-10 11:29:10 -04:00
Patrick Marsceill 01b500b1b3 Dont unesape this or it wont read the content var 2019-02-02 11:46:46 -08:00
John Boyle da0762007d escape the single quotes in the string 2019-01-31 10:02:06 -08:00
EricFromCanada 60c82cb518 Allow for ampersand in title or URL
Because `page.title` (and `page.url`) is already escaped and page titles served by lunrjs do not need escaping, ampersands need to be unescaped to display properly in search results.
2019-01-16 00:31:30 -05:00
EricFromCanada 9a4ea76957 Improve search content generator 2019-01-15 22:54:30 -05:00
EricFromCanada 793ea356c3 Use unless loop for comma
and mention `search_exclude`
2019-01-15 20:48:52 -05:00
Patrick Marsceill 46782d9352 Rake fails when dirs dont exist 2018-10-24 16:34:11 -04:00
Patrick Marsceill 62c7ac4729 Add done after creating content 2018-10-23 13:09:23 -04:00
Patrick Marsceill 25cd289df5 Fix pathing issues with gh-pages 2018-10-23 12:51:11 -04:00
Patrick Marsceill b1073290c4 remove that 2017-06-12 18:45:25 -04:00
Patrick Marsceill de40adfcac try this 2017-06-12 18:23:20 -04:00
Patrick Marsceill ee3b66c86d I dont think i need you 2017-06-12 14:24:30 -04:00
Patrick Marsceill 3929112fbb It was you the entire time 2017-06-09 11:25:19 -04:00
Patrick Marsceill db538653e5 moar quotes more problems 2017-06-09 11:23:22 -04:00
Patrick Marsceill 6bade23573 this instead 2017-06-09 11:21:38 -04:00
Patrick Marsceill dbd91523f7 lets try to pull this into a var 2017-06-09 11:19:13 -04:00
Patrick Marsceill 6432128769 escape the quotes better 2017-06-09 11:09:55 -04:00
Patrick Marsceill 87337768cc whitespace 2017-06-09 10:58:35 -04:00
Patrick Marsceill 89fe4de7b5 this needs quotes 2017-06-09 09:46:09 -04:00
Patrick Marsceill c5aa0583cb Clean up rake file 2017-06-09 09:43:20 -04:00
Patrick Marsceill 3ee6887c51 Add search namespace 2017-06-08 14:24:29 -04:00
Patrick Marsceill f4a3592fa4 Fix escapes" 2017-06-08 14:19:34 -04:00
Patrick Marsceill 56fa70775d Escape this 2017-06-08 09:47:24 -04:00
Patrick Marsceill f0bebce3b4 fix rake task 2017-06-08 09:43:33 -04:00
Patrick Marsceill b06e4198df Add the rake tasks for search init 2017-06-04 17:49:20 -04:00