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
Alexey Pyltsyn
02822b8a42
refactor: use only one close icon ( #5487 )
2021-09-22 13:36:37 +02:00
Alexey Pyltsyn
8a85031078
refactor: use CSS Modules for styles of toggle ( #5592 )
2021-09-22 12:31:05 +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
Alexey Pyltsyn
911d6b1087
fix: highlight active item in recent post list ( #5571 )
2021-09-21 17:07:24 +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
Alexey Pyltsyn
453d9c099d
fix: remove deprecated createRequireFromPath ( #5496 )
2021-09-11 12:39:33 +03:00
Sébastien Lorber
28d2d6a8d0
polish: prevent pop navigation on back if navbar sidebar is open ( #5485 )
2021-09-03 18:31:32 +02:00
Joshua Chen
52844f2b01
polish(theme-classic): add Chinese translations ( #5472 )
...
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-09-03 15:03:23 +02:00
Alexey Pyltsyn
812327155b
fix: use heading itself as anchor for better crawling ( #5481 )
2021-09-03 13:11:06 +02: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
Gabriel Csapo
cb8718a1e3
feat: adds blog archive route ( #5428 )
...
* [feature] adds blog archive route
* Update plugin-content-blog.md
* fix TS issues + minor refactors
* remove useless css
* add translation apis
* add missing translations
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-02 17:35:13 +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
402a5e1f88
feat: infima 33 + navbar-sidebar close button ( #5460 )
...
* infima 33 + navbar-sidebar close button
* duplicate close icons + theme switch margin
2021-09-01 19:48:13 +02:00
Joshua Chen
78d84006bb
refactor(theme-classic): completely migrate package to TypeScript ( #5459 )
...
* Migrate
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Migrate prism as well
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix lock file
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix typing
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* refactor a bit CodeBlock
* simplify versionBanner typing => use null instead of "none" (apart plugin options for retrocompatibility)
* Remove return signatures
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-01 14:34:26 +02:00
Joshua Chen
5f003bcabd
feat(theme-classic): allow passing tab label and default value through TabItem ( #5442 )
...
* Implement feature
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Dogfood edge case
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Correct keydown handling
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update index.tsx
* Update markdown-features-tabs.mdx
* Update markdown-features-tabs.mdx
* polish tabs doc
* Update markdown-features-tabs.mdx
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-01 12:44:37 +02:00
Sébastien Lorber
553f914639
feat: TypeScript presets/plugins should expose Options typing ( #5456 )
...
* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme
* each TS plugin should export option types + preset export option / themeConfig types + remove TS typechecking for the bootstrap theme
* fix remaining TS errors
* fix remaining TS errors
* TS fix
* Add JSDoc type annotations to init templates and TS docs
* missing title char
2021-09-01 12:14:40 +02:00
Sébastien Lorber
42e70e6d42
feat: new docs options: versions.{badge,className} ( #5454 )
...
* docs: add versions.{badge,className} options
* remove badge option test
2021-08-31 15:40:37 +02:00
Alexey Pyltsyn
914e204dcb
refactor: use SVG for closable button in announcement bar ( #5453 )
2021-08-31 11:03:14 +02:00
Sébastien Lorber
3a312d964d
feat: Add docs-related stable classnames ( #5445 )
2021-08-31 11:00:46 +02:00
Sébastien Lorber
280a8abac9
fix: fix some theme UI issues (blockquotes, navbar-sidebar font) with Infima alpha.32 ( #5444 )
2021-08-30 18:34:59 +02:00
Alexey Pyltsyn
a9e0e99dc5
refactor: switch to Flexbox in announcement bar ( #5430 )
...
* refactor: switch to Flexbox in announcement bar
* Fixes after review
* Fixes after review
* Fixes after review
2021-08-30 16:43:58 +02:00
Joshua Chen
df3752cc71
fix: fix a few TS errors ( #5437 )
...
* fix errors
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix website
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Revert adding lib
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Restore previous ordering
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* exclude sw.js from typechecking
* Tests: include typechecking of website
* cleanup @site/ alias in TS config
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-30 13:06:00 +02:00
Ali Saki
74f060dde0
refactor: update Arabic and Persian translations ( #5434 )
...
* Update Arabic Translation
* Update Persian Translation
* fix spacing problem for ar.json
* fix spacing problem for fa.json
* Update fa.json
Update Persian translation to match with @farshidinanloo translation
* fix ar.json
* Update fa.json to match with @farshidinanloo
2021-08-30 12:59:55 +02:00
farshid
f1ae06f470
refactor: add missing translations in fa.json ( #5410 )
...
* Update fa.json
fix Persian translation
* Update fa.json
* Update fa.json
* add missing translations in fa.json
* Update fa.json
2021-08-30 11:24:16 +02:00
Sébastien Lorber
7fba381a10
fix: some beta.5 bugfixes ( #5431 )
2021-08-27 15:25:16 +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
Sébastien Lorber
2a72c64581
fix: toc does not highlight clicked anchor + use scroll-margin-top ( #5425 )
...
* fix toc highlighting anchorTopOffset issues
* fix comment
* use ternary
* revert to previous offset
2021-08-26 16:50:40 +02:00
Alexey Pyltsyn
1f1c7f1695
refactor: make dynamic authors layout via CSS only ( #5424 )
...
* refactor: make dynamic authors layout via CSS only
* Clarify author class name
2021-08-26 16:49:49 +02:00
Alexey Pyltsyn
22eebea81e
fix: make tags wrapping properly ( #5422 )
2021-08-26 14:31:22 +02:00
Alexey Pyltsyn
03f8cab5e3
fix: various fixes back-to-top button ( #5419 )
2021-08-26 14:27:54 +02:00
Joshua Chen
493225a3c6
feat(plugin-blog): multi-authors support + authors.yml global configuration ( #5396 )
...
* Complete function
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* A lot of blank lines
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More lenient validation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove or
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Simpler logic
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Expand docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Better docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Dogfood
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More writeup
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move mergeAuthorMap to authors.ts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Unbreak relative assets
* Update docs
* Clarify in docs
* simplify feed authors
* rename authorMap -> authorsMap
* mergeAuthorsMap -> getBlogPostAuthors
* website => 5 blog posts per page
* improve authors map file
* Extract new theme authors components + display in row
* add comment for meta array syntaxes
* blog => getPathsToWatch should watch authorsMap file
* remove useless v1 blog FBID frontmatter
* keep older frontmatter syntax for now
* revert blog frontmatter
* Better console message
* better blog authors frontmatter impl
* add multi authors to beta blog post + fix some authors margins
* fix React key
* Refactor: mdx loader should support a more flexible assets system (poc, not documented yet)
* better display of blog post authors: adapt layout to authors count + add line clamp
* smaller local image
* fix blog feed tests
* fix blog frontmatter tests + improve validation schema
* add more frontmatter tests
* add tests for getAuthorsMapFilePath
* tests for validateAuthorsMapFile
* add tests for readAuthorsMapFile
* test getAuthorsMap
* exhaustive tests for getBlogPostAuthors
* fix remaining tests
* missing blog plugin author tests
* fix windows tests
* improve blog multi-author's doc
* Use new format in init template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Improve error message
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* update feed snapshot
* blog authors: limit to 2 cols + fix margins for no authors
* minor doc improvements
* better init template blog posts, demonstrating Blog features
* replace the legacy blog author frontmatter in remaining places
* Prefer using clsx
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* cleanup getColClassName
* remove blog author name/title line-clamping
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-26 12:21:58 +02:00
Joshua Chen
8e1cde135c
feat: make blog config options and navbar versions dropdown label translatable ( #5371 )
...
* Translate versions dropdown label
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Make blog options tranlatable
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix names
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename functions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename translations path
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update Chinese translations
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove space
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add jest test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix copyright typing
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update options
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-20 17:11:59 +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
2021-08-20 16:36:18 +02:00
Alexey Pyltsyn
4339f74da7
refactor: various tags improvements ( #5386 )
...
* refactor: various tags improvements
* Fixes after review
* Better styling with Infima
2021-08-20 12:38:54 +02:00
Alexey Pyltsyn
974644d16b
refactor: make main heading size changeable via CSS var ( #5377 )
2021-08-19 17:25:34 +02:00
Sébastien Lorber
bcb883055e
fix: fix Locale Dropdown RTL icon + Webpack aliases ordering ( #5383 )
...
* fix Locale dropdown IconLanguage RTL margin
* add more alias test fixtures for nested elements
* change webpack alias ordering logic to handle nested items better
* another aliases order fix
2021-08-19 16:22:16 +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
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main ( #5345 )
...
* Prepare to renaming master branch to main
* Update CONTRIBUTING.md
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
* missing master -> main replaces
* useless char
* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required
* fix versioning page
* fix vercel links
* update deployment.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
Alexey Pyltsyn
ee6882650e
refactor: add blog microdata in markup instead of use JSON-LD ( #5355 )
...
* refactor: add blog microdata in markup intead of use JSON-LD
* Add check for authorTitle
2021-08-17 12:21:25 +02:00
Massoud Maboudi
7b807fd85c
refactor: improved Farsi default translations ( #5365 )
...
* changed the arrow icon direction for the nabvar in mobile size
* refactor(v2): improved Farsi default translations
2021-08-15 22:38:36 +03:00
Sébastien Lorber
b8841de53a
fix: refactor TOC highlighting + handle edge cases ( #5361 )
2021-08-14 18:53:24 +02:00
Sébastien Lorber
416e2a7a29
fix: code blocks should scroll in RTL direction ( #5357 )
2021-08-13 18:28:03 +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
Alexey Pyltsyn
cbff487516
fix: author/image adjustments in BlogPosting schema ( #5346 )
2021-08-12 15:10:19 +02:00
