mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-05 11:41:22 -06:00
70b34f01f7
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>
73 lines
3.8 KiB
JSON
73 lines
3.8 KiB
JSON
---
|
|
permalink: /assets/js/search-data.json
|
|
---
|
|
{
|
|
{%- assign i = 0 -%}
|
|
{%- assign pages_array = "" | split: "" -%}
|
|
{%- assign pages_array = pages_array | push: site.html_pages -%}
|
|
{%- if site.just_the_docs.collections -%}
|
|
{%- for collection_entry in site.just_the_docs.collections -%}
|
|
{%- assign collection_key = collection_entry[0] -%}
|
|
{%- assign collection_value = collection_entry[1] -%}
|
|
{%- assign collection = site[collection_key] -%}
|
|
{%- if collection_value.search_exclude != true -%}
|
|
{%- assign pages_array = pages_array | push: collection -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- endif -%}
|
|
{%- for pages in pages_array -%}
|
|
{%- for page in pages -%}
|
|
{%- if page.title and page.search_exclude != true -%}
|
|
{%- assign page_content = page.content -%}
|
|
{%- assign heading_level = site.search.heading_level | default: 2 -%}
|
|
{%- for j in (2..heading_level) -%}
|
|
{%- assign tag = '<h' | append: j -%}
|
|
{%- assign closing_tag = '</h' | append: j -%}
|
|
{%- assign page_content = page_content | replace: tag, '<h1' | replace: closing_tag, '</h1' -%}
|
|
{%- endfor -%}
|
|
{%- assign parts = page_content | split: '<h1' -%}
|
|
{%- assign title_found = false -%}
|
|
{%- for part in parts offset: 1 -%}
|
|
{%- assign titleAndContent = part | split: '</h1>' -%}
|
|
{%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
|
|
{%- assign title = title[1] | strip_html -%}
|
|
{%- assign content = titleAndContent[1] -%}
|
|
{%- assign url = page.url -%}
|
|
{%- if title == page.title and parts[0] == '' -%}
|
|
{%- assign title_found = true -%}
|
|
{%- else -%}
|
|
{%- assign id = titleAndContent[0] -%}
|
|
{%- assign id = id | split: 'id="' -%}
|
|
{%- if id.size == 2 -%}
|
|
{%- assign id = id[1] -%}
|
|
{%- assign id = id | split: '"' -%}
|
|
{%- assign id = id[0] -%}
|
|
{%- capture url -%}{{ url | append: '#' | append: id }}{%- endcapture -%}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- unless i == 0 -%},{%- endunless -%}
|
|
"{{ i }}": {
|
|
"doc": {{ page.title | jsonify }},
|
|
"title": {{ title | jsonify }},
|
|
"content": {{ content | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
|
|
"url": "{{ url | relative_url }}",
|
|
"relUrl": "{{ url }}"
|
|
}
|
|
{%- assign i = i | plus: 1 -%}
|
|
{%- endfor -%}
|
|
{%- unless title_found -%}
|
|
{%- unless i == 0 -%},{%- endunless -%}
|
|
"{{ i }}": {
|
|
"doc": {{ page.title | jsonify }},
|
|
"title": {{ page.title | jsonify }},
|
|
"content": {{ parts[0] | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '<ul', ' . <ul' | replace: '</ul', ' . </ul' | replace: '<ol', ' . <ol' | replace: '</ol', ' . </ol' | replace: '</tr', ' . </tr' | replace: '<li', ' | <li' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | replace: '<td', ' | <td' | replace: '</th', ' | </th' | replace: '<th', ' | <th' | strip_html | remove: 'Table of contents' | normalize_whitespace | replace: '. . .', '.' | replace: '. .', '.' | replace: '| |', '|' | append: ' ' | jsonify }},
|
|
"url": "{{ page.url | relative_url }}",
|
|
"relUrl": "{{ page.url }}"
|
|
}
|
|
{%- assign i = i | plus: 1 -%}
|
|
{%- endunless -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- endfor %}
|
|
}
|