-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6937 from readthedocs/mkdocs-search
Add support for Mkdocs search
- Loading branch information
Showing
17 changed files
with
330 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{ | ||
"config": { | ||
"lang": [ | ||
"en" | ||
], | ||
"prebuild_index": false, | ||
"separator": "[\\s\\-]+" | ||
}, | ||
"docs": [ | ||
{ | ||
"location": "", | ||
"text": "Read the Docs MkDocs Test Project This is a test of MkDocs as it appears on Read the Docs.", | ||
"title": "Read the Docs MkDocs Test Project" | ||
}, | ||
{ | ||
"location": "#read-the-docs-mkdocs-test-project", | ||
"text": "Read the Docs MkDocs Test Project This is a test of MkDocs as it appears on Read the Docs.", | ||
"title": "Read the Docs MkDocs Test Project" | ||
}, | ||
{ | ||
"location": "versions/", | ||
"text": "Versions & Themes There are a number of versions and themes for mkdocs.", | ||
"title": "Versions & Themes" | ||
}, | ||
{ | ||
"location": "versions/#versions-themes", | ||
"text": "Versions & Themes There are a number of versions and themes for mkdocs.", | ||
"title": "Versions & Themes" | ||
} | ||
] | ||
} |
24 changes: 24 additions & 0 deletions
24
readthedocs/search/tests/data/mkdocs/in/search_index_old.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"docs": [ | ||
{ | ||
"location": "/", | ||
"text": "Read the Docs MkDocs Test Project\n\n\nThis is a test of \nMkDocs\n as it appears on \nRead the Docs\n.", | ||
"title": "Read the Docs MkDocs Test Project" | ||
}, | ||
{ | ||
"location": "/#read-the-docs-mkdocs-test-project", | ||
"text": "Read the Docs MkDocs Test Project\n\n\nThis is a test of \nMkDocs\n as it appears on \nRead the Docs\n.", | ||
"title": "Read the Docs MkDocs Test Project" | ||
}, | ||
{ | ||
"location": "/versions/", | ||
"text": "Versions & Themes\n\n\nThere are a number of versions and themes for mkdocs.", | ||
"title": "Versions & Themes" | ||
}, | ||
{ | ||
"location": "/versions/#versions-themes", | ||
"text": "Versions & Themes\n\n\nThere are a number of versions and themes for mkdocs.", | ||
"title": "Versions & Themes" | ||
} | ||
] | ||
} |
26 changes: 26 additions & 0 deletions
26
readthedocs/search/tests/data/mkdocs/out/search_index.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
[ | ||
{ | ||
"title": "Read the Docs MkDocs Test Project", | ||
"path": "index.html", | ||
"sections": [ | ||
{ | ||
"id": "read-the-docs-mkdocs-test-project", | ||
"title": "Read the Docs MkDocs Test Project", | ||
"content": "Read the Docs MkDocs Test Project This is a test of MkDocs as it appears on Read the Docs." | ||
} | ||
], | ||
"domain_data": {} | ||
}, | ||
{ | ||
"title": "Versions & Themes", | ||
"path": "versions/index.html", | ||
"sections": [ | ||
{ | ||
"id": "versions-themes", | ||
"title": "Versions & Themes", | ||
"content": "Versions & Themes There are a number of versions and themes for mkdocs." | ||
} | ||
], | ||
"domain_data": {} | ||
} | ||
] |
26 changes: 26 additions & 0 deletions
26
readthedocs/search/tests/data/mkdocs/out/search_index_old.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
[ | ||
{ | ||
"title": "Read the Docs MkDocs Test Project", | ||
"path": "index.html", | ||
"sections": [ | ||
{ | ||
"id": "read-the-docs-mkdocs-test-project", | ||
"title": "Read the Docs MkDocs Test Project", | ||
"content": "Read the Docs MkDocs Test Project This is a test of MkDocs as it appears on Read the Docs ." | ||
} | ||
], | ||
"domain_data": {} | ||
}, | ||
{ | ||
"title": "Versions & Themes", | ||
"path": "versions/index.html", | ||
"sections": [ | ||
{ | ||
"id": "versions-themes", | ||
"title": "Versions & Themes", | ||
"content": "Versions & Themes There are a number of versions and themes for mkdocs." | ||
} | ||
], | ||
"domain_data": {} | ||
} | ||
] |
Oops, something went wrong.