Alexey Pyltsyn
58720c93e8
refactor: simplify Toggle component ( #6049 )
2021-12-05 09:31:57 +08: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
Sébastien Lorber
95f911efef
fix(v2): Browser storage (localStorage) is unreliable: api should fail-safe ( #6040 )
2021-12-02 19:33:03 +01:00
Armano
411b9aa977
chore: cleanup dependency declaration in package.json ( #5985 )
...
* deps: add/move dependencies and treat types as dev
* chore: fix merge conflict
* Update package.json
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-23 13:59:28 +08:00
Joshua Chen
0374426ce3
chore: upgrade TypeScript & other ESLint related deps ( #5963 )
...
* chore: upgrade ESLint related deps
* Upgrade TS
* Fix lock
* Bump Babel
* Update config
2021-11-18 21:15:37 +08:00
Armano
425144afc7
refactor(theme-search-algolia): migrate package to TS ( #5935 )
2021-11-16 20:35:09 +01:00
Joshua Chen
d1308a8736
refactor: improve setup of type declaration files ( #5914 )
2021-11-12 17:47:27 +01:00
Joshua Chen
334470b5d4
refactor(theme-classic): move some logic of CodeBlock to theme-common ( #5922 )
2021-11-12 16:43:40 +01: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
Alexey Pyltsyn
91ec2509b7
chore: prepare v2.0.0-beta.9 release ( #5859 )
...
* chore: prepare v2.0.0-beta.9 release
* v2.0.0-beta.9
2021-11-02 20:40:01 +03: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
Sergio Moreno
adbc02ea38
feat(search-algolia): algolia externalUrl regex to navigate with window.href ( #5795 )
2021-10-29 19:53:47 +02:00
Sébastien Lorber
1ce6253cc1
chore: require Node 14 ( #5812 )
2021-10-28 17:11:25 +02:00
Joshua Chen
4b2152a964
refactor: clear a few ESLint warnings ( #5808 )
...
* refactor: clear a few ESLint warnings
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix
2021-10-28 12:47:40 +08:00
Joshua Chen
72990726e5
refactor: fix a few type inconsistencies ( #5788 )
2021-10-27 11:53:08 +02:00
Sébastien Lorber
68a116611f
chore: prepare v2.0.0-beta.8 release ( #5762 )
2021-10-21 18:52:17 +02:00
Sébastien Lorber
098f210890
chore: Enable ESLint rules of hooks + fix new lint errors ( #5714 )
2021-10-20 16:09:52 +02:00
Alexey Pyltsyn
877373e108
chore: prepare v2.0.0-beta.7 release ( #5713 )
...
* chore: prepare v2.0.0-beta.7 release
* v2.0.0-beta.7
2021-10-15 16:31:01 +03:00
Alexey Pyltsyn
1361a5a38e
fix: proper collapsing of long element ( #5694 )
...
* fix: proper collapsing of long element
* Add example
* Reorder
* Another solution with overflow
* Restore original solution
2021-10-15 16:02:56 +03:00
Alexey Pyltsyn
e22170408a
refactor: cleanup scroll handlers ( #5709 )
2021-10-15 13:07:03 +02:00
Joshua Chen
c8739ec28e
polish(theme-classic): guard against potential definition mistakes in Tabs ( #5674 )
2021-10-14 15:47:03 +02:00
Alexey Pyltsyn
fee10c9e13
fix: apply announcement bar class if only needed ( #5699 )
2021-10-14 11:10:59 +02:00
Shrugsy
7868df13f1
feat: maintain page position for clicked grouped tabs ( #5618 )
...
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-10-13 19:08:00 +02:00
Joshua Chen
eaacb0e98a
feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization ( #5642 )
...
* Initial work
* Complete function
* Avoid duplication
* More dedupe
* Make everything constants
* Change casing & docs
2021-10-07 16:59:02 +02:00
Bharat Middha
09550b0535
feat: properly type-check the Docusaurus config of new sites ( #5589 )
...
* fix: makes types DocusaurusConfig optional to match docs
* add UserDocusaurusConfig with required keys for user config
* convert UserDocusaurusConfig to use util type
* Docusaurus website config should be type-checked by CI + fix all existing issues
* add doc for config typechecking
* Update template configs for TS autocompletion
* fix last config typechecking bugs
* reapply prettier
* reapply prettier-docs
* Fix TS doc: add missing ()
* fix some docu plugin types
* add "const config" for simpler jsdoc annotation
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-30 17:49:44 +02:00
Joshua Chen
3f1f8255a2
chore: upgrade Prettier + regenerate lock file ( #5611 )
...
* Bump deps
* Run prettier
* Format docs
* Minor refactor
* Collapse objects
* Fix type
* Update lock file
2021-09-30 12:54:17 +02:00
Alexey Pyltsyn
4dbc458a22
refactor: various TOC improvements ( #5627 )
2021-09-30 12:22:32 +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
Alexey Pyltsyn
b62a12bfc6
chore: upgrade dependencies ( #5608 )
...
* chore: upgrade dependencies
* Revert github-slugger
* Fixes
* Update snapshots
* Update Babel deps
2021-09-24 16:36:41 +02:00
Joshua Chen
a839966cd2
polish: remove unused eslint-disable ( #5560 )
...
* fix eslint
* Add report unused disable to CI
* Fix two anys
2021-09-21 18:07:54 +02:00
Don
b6d0378704
refactor: adjust styling of back top top button ( #5469 )
...
* refactor: css variables for back to top button
* refactor: adjust back to top button styling
* Update from PR feedback
* err... darker.
* swap secondary color for emphasis scale
* reduce contrast further
* Add new translations
* Cleanup CSS
* Remove active state
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2021-09-11 16:09:58 +03:00
Sébastien Lorber
2611bbb501
chore(v2): prepare v2.0.0-beta.6 release ( #5473 )
...
* add beta.6
* v2.0.0-beta.6
2021-09-02 18:31:42 +02:00
Sébastien Lorber
f361e89b14
feat: on back navigation, close mobile sidebar ( #5462 )
...
* On back, close mobile navbar sidebar
* more reliable code to block history pop events
* android backbutton: just close the drawer without cancellin the backward navigation
2021-09-02 16:03:17 +02:00
Sébastien Lorber
3a312d964d
feat: Add docs-related stable classnames ( #5445 )
2021-08-31 11:00:46 +02:00
Sébastien Lorber
f600d5a6d7
chore: prepare v2.0.0-beta.5 release ( #5427 )
...
* beta.5
* v2.0.0-beta.5
2021-08-26 17:33:31 +02:00
Alexey Pyltsyn
0dd4892b0f
refactor: improve styles of Details component ( #5402 )
...
* refactor: improve styles of Details component
* Use vendor prefix for ::marker
* Wording
2021-08-26 16:46:35 +02:00
John Reilly
08597045ed
feat: add metatags support for seo / blogposts #5373 ( #5375 )
...
* feat: add metatags support for seo / blogposts
* feat: different implementation
* feat: use isBlogPostPage
* feat: implement in BlogPostPage-remove Seo changes
* Revert "feat: implement in BlogPostPage-remove Seo changes"
This reverts commit 1cba459b
* Move Seo to BlogPostPage + some fixes
* fix social preview asset
* Fix blog social image + improve a bit Seo setup
* fix bootstrap theme
Co-authored-by: John <john.reilly@investec.co.uk>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-20 16:36:18 +02:00
Isaac Philip
f9c79cbd58
feat: doc tags (same as blog tags) ( #3646 )
...
* [v2] tags to doc, same as tags to blog - [IN PROGRESS]
- Addition of plugin-content-docs
- Addition of DocTagsListPage in `docusaurus-theme-classic`
! Error exists for this commit towards the theme aspect and help required.
Commit towards #3434
* docs: make tags list page work
* temp: disable onBrokenLinks
* theme bootstrap: create DocTagsListPage
* DocTagsPage added and functionality too
- individual doc tag page added to show docs for that specific tag
* Added all Docs Tags Link
* add some shared tag utils
* move tag tests to _dogfooding
* fix type
* fix some tests
* fix blog test
* refactor blog post tags handling
* better yaml tag examples
* better dogfood md files
* refactor and factorize theme tag components
* finish DocTagDocListPage
* Extract DocItemFooter + add inline tag list
* minor fix
* better typings
* fix versions.test.ts tests
* add tests for doc tags
* fix tests
* test toTagDocListProp
* move shared theme code to tagUtils
* Add new theme translation keys
* move common theme code to tagUtils + add tests
* update-code-translations should handle theme-common
* update french translation
* revert add translation
* fix pluralization problem in theme.docs.tagDocListPageTitle
* add theme component configuration options
* add more tags tests
* add documentation for docs tagging
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-19 10:31:15 +02:00
Alexey Pyltsyn
ce92f30d33
fix: unbreak Details component ( #5364 )
2021-08-17 12:04:32 +02:00
Sébastien Lorber
295e77cc09
refactor(core): replace useDocusaurusContext().isClient by useIsBrowser() ( #5349 )
...
* extract separate useIsClient() hook
* for consistency, rename to `useIsBrowser`
* useless return
* improve doc for BrowserOnly
* update snapshot
* polish
2021-08-12 19:02:29 +02:00
Joshua Chen
69b11a8546
polish: bind key listener to light/dark toggle + a11y lint fixes ( #5341 )
...
* Fix Details a11y
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove keydown logic
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix toggle
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Proper way to fix toggle
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Proper way to fix details
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Put callback back
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-12 16:33:31 +02:00
Joshua Chen
ee6ebc4877
refactor: better typing + remove unnecessary eslint-disable ( #5335 )
...
* Initial work
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix a few errors
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Restore default value
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Use custom route config
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Address a few suggestions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Revert logo change
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Restore key
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Oops
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove use of any
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove eslint-disable
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Put type reference back
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-11 16:07:17 +02:00
Joshua Chen
780e924a9e
fix: fix constant value import ( #5297 )
...
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-05 14:54:09 +02:00
Joshua Chen
0a668366c2
refactor: properly type docs version ( #5284 )
...
* Type docs version
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move non-null assertions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Test again
2021-08-05 10:52:35 +02:00
Joshua Chen
9e615eff02
refactor: reduce ESLint warnings / better typing ( #5242 )
...
* Fix code block children type
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add return type
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add types
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix return types
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix details type
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix type
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-07-29 17:59:38 +02:00
Sébastien Lorber
fc64c12e41
chore(v2): prepare v2.0.0-beta.4 release ( #5238 )
...
* chore(v2): prepare v2.0.0-beta.4 release
* update publish
* v2.0.0-beta.4
2021-07-28 22:54:41 +02:00
Sébastien Lorber
dc4664b489
feat: details/summary theme / MDX component ( #5216 )
...
* Details component
* polish arrow animation
* fix text selection bug
* fix some edge cases + polish
* example of overriding baseClassName
* Move Details component to theme-common
* make component work even when JS is disabled or failed to load
* update arrow transform
* Details component: better handling of no-JS fallback mode: avoid delaying arrow navigation when JS (see review)
* prefix css vars with --docusaurus
* improve css arrow styling
* slightly change details/summary design
* better md doc + include quotes and details in doc
2021-07-27 18:45:12 +02:00
Joshua Chen
24156efcfb
feat: docs plugin options sidebarCollapsible + sidebarCollapsed ( #5203 )
...
* Add prop
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add `collapsible` option to sidebar item
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add eslint-ignore
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move new page
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Allow in autogenerated
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tests
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move config options to plugin-docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Make non-collapsible items always expanded
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* docs versioning cli should receive a single options object
* Update cli.test.ts
* revert validateCategoryMetadataFile change
* remove theme usage of themeConfig.sidebarCollapsible
* better handling of sidebar item category inconsistencies + add warning message
* Update snapshot
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Handle plugin option inconsistencies
* improve doc for new sidebarCollapsible doc options
* remove warning in fixSidebarItemInconsistencies as it will be annoyed for versioned sites, as "collapsed" is already persisted in sidebar json files
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-23 14:24:36 +02:00
Sébastien Lorber
818fb3956b
refactor(v2): mobile dropdown navbar: expand when subitem become active ( #5168 )
2021-07-14 19:42:47 +02:00
Sébastien Lorber
677e53d4db
perf(v2): lazy collapsibles, reduce html output and build times ( #5136 )
...
* Allow collapsible to be lazy
* cleanup comments
* CollapsibleLazy little bug
2021-07-14 16:18:52 +02:00