Joshua Chen
51815c12c9
feat(theme-classic): extensible code block magic comment system ( #7178 )
2022-05-04 12:31:13 +02:00
Alexey Pyltsyn
84d04ed6ed
feat(theme-classic): new 'html' type navbar item ( #7058 )
...
* feat(theme-classic): allow using html in dropdown items
* Fix tests
* Introduce HTML type for navbar item
* Update packages/docusaurus-theme-classic/src/theme/NavbarItem/HtmlNavbarItem.tsx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-15 18:58:15 +08:00
Alexey Pyltsyn
bfbc78e52a
feat: allow using pure HTML as label in navbar links ( #7079 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-04-07 12:33:52 +02:00
Alexey Pyltsyn
ecbe0b26c5
refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook ( #6930 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-03-18 15:28:35 +01:00
Joshua Chen
7ec44bb32c
refactor(theme-classic): replace color mode toggle with button; remove switchConfig ( #6771 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-03-02 15:57:17 +01:00
Alexey Pyltsyn
53c2c118c4
feat(search-algolia): allow disabling search page and configuring path ( #6692 )
2022-02-16 19:07:01 +01:00
Nick Schonning
521eb119a7
chore: add cSpell for spell checking ( #6456 )
...
* chore: Add cSpell for spell checking
* chore: exclude map files and remove dups
* chore: exclude more binary files
* chore: remove MD headings
* Update .cspell.json
* fix a few spellings
* fix more
* fix
Signed-off-by: Joshua Chen <sidachen2003@gmail.com>
* fix a few
* oops
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-25 09:40:02 +08:00
Nick Schonning
2528226eeb
chore: add height/width for front page images ( #6385 )
...
* chore: add height/width for Lighthouse performance
* use auto width
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-23 09:57:31 +08:00
Joshua Chen
db471d97ab
fix(website): various anchor link fixes ( #6318 )
2022-01-12 08:35:47 +08:00
Sébastien Lorber
f87a3ead46
refactor: move @theme/hooks to @docusaurus/theme-common ( #6289 )
2022-01-07 19:19:35 +01:00
Minh Pham
eade41a702
feat(theme-classic): new navbar item linking to a sidebar ( #6139 )
...
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-06 11:52:25 +01:00
Joshua Chen
4872decb42
docs: normalize CodeBlock highlighting ( #6223 )
2021-12-30 10:51:00 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +01:00
Christopher Klint
d987c22996
feat(theme-classic): new configuration syntax for a simple footer ( #6132 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2021-12-20 19:45:27 +01:00
Sébastien Lorber
cfae5d0933
feat(content-docs): sidebar category linking to document or auto-generated index page ( #5830 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: Armano <armano2@users.noreply.github.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-12-03 14:44:59 +01:00
Joshua Chen
ecce576bbc
docs: new APITable comp to render large tables ( #5891 )
2021-11-10 11:38:23 +01:00
Joshua Chen
4478dd9659
docs: make API sidebar partially autogenerated ( #5917 )
...
* docs: make API sidebar autogenerated
* fix paths
2021-11-10 14:08:50 +08:00
Swalah Amani
c541e2d83c
misc: replace all "Metadatas" with "Metadata" ( #5871 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-09 19:46:10 +01:00
Devtato
41ef9daafd
feat(theme-classic): allow specifying width/height in logo ( #5770 )
...
* feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* fixup! feat: changed the logo properties to allow width/height specification
* Rework: add fields to logo object
* Fix
* More fixes
* Wrong width!
* No need for optional chaining
* Doc writeup
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-01 18:09:30 +08:00
Joshua Chen
7468136f88
docs: include navbar item type in the API table ( #5821 )
2021-10-29 18:11:07 +08:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages ( #5728 )
2021-10-19 20:15:11 +02:00
Sébastien Lorber
a0c2c52829
chore: remove unused Bootstrap theme ( #5634 )
...
* remove package
* remove bootstrap from doc
* remove bootstrap init template + examples
* remove bootstrap preset
* remaining bootstrap refs
* update lockfile
2021-10-01 17:44:34 +02:00
Erick Zhao
c86dfbda61
feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) ( #5578 )
...
* feat: add all TOC levels to MDX loader
* feat: add theme-level config for heading depth
* test: add remark MDX loader test
* fix: limit maxDepth validation to H2 - H6
* refactor: set default `maxDepth` using `joi`
* refactor: `maxDepth` -> `maxHeadingLevel
* refactor: invert underlying TOC depth API
* refactor: make TOC algorithm level-aware
* feat: add support for per-doc TOC heading levels
* feat: support document-level heading levels for blog
* fix: correct validation for toc level frontmatter
* fix: ensure TOC doesn't generate redundant DOM
* perf: simpler TOC heading search alg
* docs: document heading level props for `TOCInline`
* Update website/docs/guides/markdown-features/markdown-features-inline-toc.mdx
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
* docs: fix docs (again)
* create dedicated test file for heading searching logic: exhaustive tests will be simpler to write
* toc search: add real-world test
* fix test
* add dogfooding tests for toc min/max
* add test for min/max toc frontmatter
* reverse min/max order
* add theme minHeadingLevel + tests
* simpler TOC rendering logic
* simplify TOC implementation (temp, WIP)
* reverse unnatural order for minHeadingLevel/maxHeadingLevel
* add TOC dogfooding tests to all content plugins
* expose toc min/max heading level frontmatter to all 3 content plugins
* refactor blogLayout: accept toc ReactElement directly
* move toc utils to theme-common
* add tests for filterTOC
* create new generic TOCItems component
* useless css file copied
* fix toc highlighting className conflicts
* update doc
* fix types
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-29 11:19:11 +02:00
Forresst
02eee61aa5
docs: improve escape pipe in Markdown tables ( #5539 )
...
* Test escape pipe in Markdown table
From a remark on Crowdin:
> The value for the Type entry in the plugin-content-blog page is strange.
> In English documents, the Type item value is normally displayed.
> ex) editUrl: string | EditUrlFunction
> However, in French documentation, the Type item value is shown as an unknown code.
> ex) editUrl:!!crwdBlockTags_249_sgaTkcolBdwrc!!
> ex) blogSidebarCount: !!crwdBlockTags_250_sgaTkcolBdwrc!!
This is a test to see if the other way to escape a pipe in a markdown table could solve the problem.
* Fix all docs to replace | by \|
* Keep `code`
* Apply suggestions from code review
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-09-08 14:58:48 +03:00
Alexey Pyltsyn
e6f4a9b231
docs: clarify using custom attributes for navbar link ( #5423 )
2021-08-26 14:29:05 +02:00
Joshua Chen
c603056f66
docs: refactor API documentation ( #5219 )
...
* Refactor plugin-docs documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor theme-configuration
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor plugin-blog docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* plugin-pages
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor change
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Interchange table columns
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fixes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor improvements
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix hash link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move blog front matter to API
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add more blog documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update blog.md
* Update blog.md
* Update blog.md
* Update website/docs/blog.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-04 16:35:17 +02:00
Alexey Pyltsyn
2c0b82e7ab
fix: apply proper class for active doc item on mobiles + avoid duplicated classes ( #5264 )
...
* fix: apply proper class for active doc item on mobiles
* Fixes after review
2021-08-04 15:29:10 +02:00
Joshua Chen
f5f39fa8e0
docs: update API docs on navbar behavior ( #5175 )
...
* Document navbar dropdown behavior
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Partially done API documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Complete API documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add deprecation warning
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Address suggestions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor fixes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update website/docs/api/themes/theme-configuration.md
* Update website/docs/api/themes/theme-configuration.md
* Update website/docs/api/themes/theme-configuration.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-20 14:07:09 +02:00
Teik Jun
c96c3b5c39
docs(v2): fix incorrect anchor links in website ( #5021 )
...
* docs: fix anchor links for docusaurus write-translations
* docs: fix anchor links for docusaurus serve
2021-06-20 22:16:17 +03:00
Alexey Pyltsyn
d7e4e422a2
docs(v2): minor tweaks ( #4981 )
2021-06-16 11:04:40 +02:00
Pedro Queiroz
4db8ded2f2
docs(v2): fix missing closing bracket ( #4837 )
...
* fix: missing closing bracket
* fix: missing closing bracket
2021-05-24 12:37:30 +03:00
Forresst
aa392a9907
docs(v2): fix typo theme-configuration.md ( #4595 )
...
We are in the footer section, I think it's a bad copy and paste
2021-04-11 17:44:35 +02:00
Sébastien Lorber
78349480af
chore: rename v2.docusaurus.io urls after domain switch + redirect + cleanups ( #4490 )
...
* prepare v1-v2 domain switch
* rename v1 changelog as CHANGELOG-1.x.md
* switch v1/v2 changelogs
* Cleanup v2.docusaurus.io urls
* add netlify domain redirect
* remove circleci config
* remove another circle file
2021-03-22 20:57:49 +01:00
Alexey Pyltsyn
291a72fbae
docs(v2): use explicit heading IDs ( #4460 )
2021-03-19 11:00:41 +01:00
Alexey Pyltsyn
1c7d423e0c
docs(v2): various improvements ( #4369 )
...
* docs(v2): various improvements
* Update blog.md
2021-03-09 14:59:32 +01:00
tokarchyn
98a4b3a65c
feat(v2): Add playgroundPosition config for live codeblock ( #4328 )
...
* docs(v2): Add configuration parameter to allow putting Result before Editor in @docusaurus/theme-live-codeblock
* update doc
* refactor as playgroundPosition
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-03-05 14:49:17 +01:00
Alexey Pyltsyn
b3b658f687
feat(v2): allow to change location of search bar ( #4199 )
...
* feat(v2): allow to change location of search bar
* add SearchBar swizzle comment
* quickfix for NavbarItem theme config
* typing quickfix
* doc typo
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-09 16:31:52 +01:00
Sébastien Lorber
a8ee7fd3e8
docs(v2): i18n doc + polish ( #4014 )
...
* add some initial i18n doc
* i18n doc progress
* i18n tutorial progress
* i18n tutorial progress
* polish Crowdin docs
* i18n sidebar in guides
* polish crowdin doc
* update Crowdin doc a bit
* fix annoying relative link to global site resource in template (breaks i18n tutorial)
* template: use simpler export for homepage
* add markdown page example
* rename mdx.md to interactiveDoc.mdx
* update bootstrap/facebook templates too
* sync init template package scripts
* add slug frontmatter doc
* improve i18n doc
* complete i18n doc
* temporarily enable the localeDropdown
* doc typo
* improve the i18n doc
* Add Git i18n doc
* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)
* improve a bit the Crowdin doc
2021-01-19 17:26:31 +01:00
Sébastien Lorber
d5d6e2fba2
docs(v2): Add documentation for docs multi-instance support ( #3978 )
...
* Add documentation for docs multi-instance support
* Add documentation for docs multi-instance support
2020-12-30 19:41:42 +01:00
Sébastien Lorber
d99d53a236
docs(v2): Reorganize/split the guides doc sections ( #3975 )
...
* docs reorg
* refactor docs/markdown features section
* fix broken links after docs refactor
2020-12-30 17:03:25 +01:00
Sébastien Lorber
8f47babb46
docs(v2): Docs refactoring and reorganization ( #3831 )
...
* stable refactor of plugins api documentation
* plugins sidebar not collapsed by default as small?
* theme docs reorg
* Refactor migration guide doc
* fix broken link
2020-11-30 14:07:08 +01:00
