Commit graph

41 commits

Author SHA1 Message Date
Joshua Chen
ab566ecce3
docs: remove useless front matter (#7518) 2022-05-28 19:07:45 +08:00
Sébastien Lorber
a6f53aa9d2
refactor(theme-classic): bias again search metadata toward Algolia DocSearch (#6707) 2022-02-17 14:24:31 +01:00
Sébastien Lorber
49361e2ae9
docs(website): search doc typo searchParameters (#6704) 2022-02-17 11:57:30 +01:00
Alexey Pyltsyn
53c2c118c4
feat(search-algolia): allow disabling search page and configuring path (#6692) 2022-02-16 19:07:01 +01:00
Joshua Chen
b89d93fab5
refactor: recommend using data-theme without html element selector (#6668)
* refactor: recommend using data-theme without html element selector

* simplify site CSS

* refactor
2022-02-14 10:23:42 +08:00
Sébastien Lorber
dd539dd23f
feat(search): enable contextual search by default (#6407) 2022-01-25 11:45:41 +08:00
Joshua Chen
2cace21083
docs: update Algolia docs for new DocSearch infra (#6393) 2022-01-19 16:42:08 +01:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting (#6223) 2021-12-30 10:51:00 +08:00
Joshua Chen
73ee356949
docs: audit grammar issues (#6203)
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
2021-12-27 19:34:04 +08:00
Can Olcer
8359ff36cd
docs: improve algolia integration instructions (#6008)
* docs: improve algolia integration instructions

The current version makes it look like you need to install `@docusaurus/theme-search-algolia` on top the classic version to work, but it already works with the classic version. Adding `@docusaurus/theme-search-algolia` on top leads to errors.

* Still document installation

* Do not make separate paragraph

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-25 20:03:32 +08:00
琚致远
1e7f688598
docs: remove duplicated appId property (#5869) 2021-11-04 13:51:01 +08:00
Sergio Moreno
adbc02ea38
feat(search-algolia): algolia externalUrl regex to navigate with window.href (#5795) 2021-10-29 19:53:47 +02:00
Alexey Pyltsyn
d4114c77fc
docs: fix link for apply to DocSearch program (#5784) 2021-10-25 16:03:26 +03:00
Sébastien Lorber
7b64e85dc3
docs: Algolia plugin must be enabled before crawling the site (#5658) 2021-10-07 17:00:47 +02:00
Sébastien Lorber
afff053cc9
chore: prepare Algolia migration (#5632)
* prepare Algolia migration

* Update website/docs/search.md

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>

Co-authored-by: Clément Vannicatte <20689156+shortcuts@users.noreply.github.com>
2021-10-01 15:58:24 +02:00
Jason Bosco
81877d7582
docs: add additional search options, typesense and local search (#5489)
* docs: add additional search bar options - typesense and local search

* docs: add typesense docsearch to community resources

* improve search doc, explain better where to get support

* improve search doc

* improve search doc

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-22 17:41:27 +02:00
Sébastien Lorber
9efa550cd5
docs(v2): mention to install the algolia package in search doc (#4976) 2021-06-15 16:14:03 +02:00
Sébastien Lorber
df8a900f9c
feat(v2): add trailingSlash config option (#4908)
* POC: add trailingSlash option

* integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin

* Fix broken links when using trailing slash => using md links is more reliable

* fix TS issue

* minor polish

* fix doc page being sensitive to trailing slashes

* Add tests for applyTrailingSlash

* rename test files

* extract and test applyRouteTrailingSlash

* update snapshot

* add trailing slash config to serve command

* fix getSidebar() => still sensitive to trailing slash setting

* never apply trailing slash to an anchor link

* Add documentation for trailingSlash setting
2021-06-09 19:59:39 +02:00
ZhengYuan Loo
11843a02fe
docs(v2): config for self-hosted docsearch crawler (#4524) 2021-03-29 17:53:51 +02:00
Arijit Kundu
af840b7f85
docs(v2, v1): fixed typos (#4479) 2021-03-22 18:00:32 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs (#4460) 2021-03-19 11:00:41 +01:00
Theodore Chu
3ebe9cab68
docs(v2): Add how to run your own DocSearch (#4002) 2021-01-06 16:36:58 +01:00
Sébastien Lorber
f1bed8dd69
fix(v2): Algolia: allow contextualSearch + facetFilters (#3804)
* remove contextualSearch facetFilters  merging security

* update doc
2020-11-23 19:43:38 +01:00
Sébastien Lorber
21264f5ed0
feat(v2): contextual search, dynamic Algolia facetFilters (#3550)
* POC of contextual search dynamic filters

* fix useSearchTags bugs

* contextual search should use preferred version  (persisted in storage)

* Contextual search: make system decoupled from algolia + wire proper meta tags and facet filters

* rework doc tag + minor refactorings

* update snapshots

* polish contextual search

* add Algolia validateThemeConfig tests
2020-10-15 12:16:30 +02:00
Sébastien Lorber
e1b2963f31
fix(v2): absolute Links should be automatically prefixed by baseurl (#3143)
* put back the automatic withBaseUrl call, but only for urls starting with / (because useBaseUrl behavior is buggy and forces relative links to absolute links)

* fix Link typo
2020-07-28 19:40:34 +02:00
François Chalifour
298522ff66
feat(v2): introduce DocSearch v3 search (#2815)
* feat(v2): introduce DocSearch v3 search

* chore(deps): update @docsearch/react

* refactor: use arrow functions in callbacks

* fix: display warning when `algolia` config is missing

* feat: add link to search page

* chore: delete unused style file

* feat(website): specify DocSearch primary color

* fix(search): add "all" word

* feat(search): add `generateSearchPageHref` hook

* chore(deps): update @docsearch/react

* fix(website): remove `hitsPerPage` search parameter

* fix(search): use `baseUrl`

* fix(search): rename `generateSearchPageLink`

* fix(search): fix scroll position on mobile

* fix(search): update query on URL change

* fix(search): close DocSearch modal on See More click

* refactor(search): use `useSearchQuery` to update query from URL

* feat(search): support `/` keyboard shortcut

* fix(search): forward Algolia config to DocSearch

* chore(search): update `@docsearch/react`

* fix(search): encode search value to search page

* fix(search): use `withBaseUrl` on links

* feat(search): attach Docusaurus version to user agents

* docs(docsearch): update DocSearch section

* chore(deps): update @docsearch/react

* feat(search): apply search styles to website

* docs(search): update DocSearch doc

* chore(deps): update @docsearch/react

* chore: update lock file

* chore(deps): update algoliasearch

* fix(website): remove special character in CSS

* docs(search): remove special character in CSS
2020-07-23 14:36:38 +02:00
Sylvain Pace
1471a6eb3a
docs(v2): add mention that appID is optional (#2659) 2020-04-25 19:00:01 +03:00
Yangshun Tay
3dd83be988
docs(v2): proofread docs (#2527) 2020-04-04 14:05:59 +08:00
Yangshun Tay
36ea74504e
docs(v2): use codeblock title syntax instead of comments (#2473) 2020-03-29 01:08:50 +08:00
Theodore Chu
99943a6041
docs(v2): include appId key for Algolia (#2413)
* Update Algolia information

appId is needed for self-hosted Docsearch

* Update Algolia Information

https://github.com/facebook/docusaurus/pull/2413

* Update Algolia Information for alpha.40

* Update search.md

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-03-17 12:25:48 +03:00
Yangshun Tay
2b6e440970
chore(v2): v2.0.0 alpha.44 (#2379)
* chore: v2.0.0-alpha.44

* chore: v2.0.0-alpha.44

* update CHANGELOG
2020-03-08 23:43:40 +08:00
Yangshun Tay
428e087eb7
fix(v2): fix reading front matter keywords and image fields (#2165) 2019-12-31 21:42:47 +08:00
Yangshun Tay
4927f764e5 misc(v2): nitpicky formatting 2019-12-04 00:55:52 -08:00
Endi
c533adc4aa docs(v2): display yarn and npm command on website (#2037)
* docs(v2): display yarn and npm command on website

* more

* fix div cannot be descendant p
2019-11-23 18:32:26 -08:00
Eric Carboni
b027db1b34 docs(v1): remove exclusive language (#1961)
* Initial commit to replace easy, easily, simple, just, of course

* Revert ordered list change
2019-11-11 14:06:54 -08:00
Endi
64871b76e4 fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined (#1909)
* fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined

* nits

* Docs docs

* inaccuracy

* changelog

* nits
2019-10-30 08:51:53 +08:00
Yangshun Tay
f635f9aba2
docs(v2): code block line highlighting (#1904)
* docs(v2): code block line highlighting

* misc: update CHANGELOG

* misc: respond to review

* docs: add line highlighting to the template
2019-10-29 14:59:24 +08:00
Endi
d6d113b1df
docs(v2): search - algolia and custom (#1734)
* docs(v2): search - algolia and custom

* revisions
2019-08-02 11:11:32 +07:00
Wei Gao
f2864e0a91
docs(v2): analytics (#1678)
* docs(v2): analytics

* docs(v2): rework analytics docs

* fix broken link
2019-07-23 14:31:59 +08:00
Wei Gao
95fde5f827 docs(v2): refactor docs for better outline and welcoming PRs (#1641)
* docs(v2): refactor docs for better outline and welcoming PRs

* docs(v2): update docs
2019-07-07 23:14:49 -07:00
Yangshun Tay
5d6dc49bcd
docs(v2): add docs skeleton and structure (#1412)
* docs(v2): add docs skeleton and structure

* docs(v2): add on

* docs(v2): move motivation into contributing
2019-04-28 20:20:24 -07:00