Sébastien Lorber
120b99b1f3
docs(website): use .mdx extension for every docs ( #8490 )
2022-12-30 15:08:28 +01:00
Jody Heavener
683ba3d2a0
feat(docs,blog,pages): add support for "unlisted" front matter - hide md content in production ( #8004 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-11-03 14:31:41 +01:00
Sébastien Lorber
c6f5cf9ac7
docs(content-docs): add api doc for displayed_sidebar front matter ( #8146 )
2022-09-29 16:45:51 +02:00
Mikey O'Toole
e507628f4a
docs: document usage of docs frontMatter.custom_edit_url: null ( #8053 )
2022-09-07 13:21:13 +02:00
Sébastien Lorber
3b9b497d13
fix(plugin-docs,theme): refactor docs plugin routes and component tree ( #7966 )
2022-08-18 17:55:05 +02:00
Sébastien Lorber
eac3239757
feat(docs): allow to configure noIndex per doc version ( #7963 )
2022-08-17 16:55:49 +02:00
Sébastien Lorber
6df379ca6f
fix(docs): forward doc frontMatter.sidebar_custom_props to linking sidebar category ( #7638 )
2022-06-16 19:20:07 +02:00
Joshua Chen
e12a2efaeb
docs: normalize capitalization ( #7619 )
2022-06-15 13:04:33 +08:00
Joshua Chen
aeb6c971c0
docs: normalize capitalization ( #7613 )
2022-06-14 14:01:06 +08:00
Joshua Chen
bf9b69cfbf
docs: make config tabs translatable, fix APITable crowdin issue ( #7572 )
...
* docs: make config tabs translatable, fix APITable crowdin issue
* fix
2022-06-06 10:52:19 +08:00
dpang314
4f26a1911a
feat(content-docs): last_update front matter ( #7461 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-06-01 16:27:58 +02:00
Joshua Chen
ab566ecce3
docs: remove useless front matter ( #7518 )
2022-05-28 19:07:45 +08:00
James
4f97c7b52c
docs: link every reference of types in API table to the type definition ( #7497 )
...
* dogfood fix
* feat: links for plugin types
* better syntax
* little refactor
* use code title
* complete the rest
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-05-26 15:06:36 +08:00
Joshua Chen
cd21a31005
test: strengthen internal types ( #7488 )
2022-05-25 15:38:44 +08:00
Jody Heavener
5fb0a2e274
feat(content-docs): draft docs excluded from build & sidebars ( #6457 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-13 18:02:05 +02:00
Joshua Chen
2bcac29cd4
refactor(content-docs): deduplicate types, JSDoc for some APIs ( #7027 )
...
* refactor(content-docs): deduplicate types, JSDoc for some APIs
* little refactor
2022-03-27 12:57:15 +08:00
Joshua Chen
b5ceead3b2
feat(content-docs): autogenerate category with linked doc metadata as fallback ( #6859 )
2022-03-25 15:23:11 +01:00
Jody Heavener
3629b5ab39
feat(docs,theme-classic): docs breadcrumbs ( #6517 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-16 19:02:58 +01:00
Joshua Chen
1ca07f8466
refactor(content-docs): read category metadata files before autogenerating ( #6586 )
...
* refactor(content-docs): read category metadata files before autogenerating
* fix tests
* fix Windows...
* warn user when behavior is undetermined
* oops
* fix typo
2022-02-03 16:16:19 +08:00
Joshua Chen
24a895fbc5
feat(content-docs): expose isCategoryIndex matcher to customize conventions ( #6451 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-01-26 17:58:52 +01:00
Joshua Chen
06a8cdcb0f
docs: elaborate on doc versioning ( #6280 )
...
* docs: elaborate on doc versioning
* Complete
* fix
2022-01-07 14:28:48 +08:00
Joshua Chen
a03788374e
fix(website): fix config-tabs breaking after translation ( #6275 )
...
* fix(website): fix config-tabs breaking after translation
* more robust
2022-01-06 19:31:58 +08:00
Joshua Chen
5132ecdeee
docs: normalize plugin API documentation ( #6193 )
...
* docs: normalize plugin API documentation
* Revert change
* Use remark plugin
* edits
* edit again
* Fixes
2021-12-28 21:23:27 +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
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders ( #6142 )
2021-12-21 14:56:29 +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
Joshua Chen
3127f12654
feat(content-docs): new front matter options to customize pagination ( #5705 )
2021-10-21 12:27:57 +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
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
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
29e06d0677
feat: make tags route path configurable ( #5545 )
2021-09-21 19:19:18 +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
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
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
Sébastien Lorber
1257e99112
docs: try to make plugin/preset config less confusing ( #5313 )
2021-08-10 12:32:44 +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
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
8bdb3da233
feat(v2): generalize usage of _ prefix convention to exclude content files/folders ( #5173 )
...
* create a swizzleWarning partial for shared text
* Generalize usage of _ prefix convention to exclude content files/folders
* add api doc
* MDX loader should not expect metadata/frontmatter on MDX partial files
2021-07-15 13:21:41 +02:00
Lennart Koopmann
f74e6c5107
docs(v2): clarify how to disable edit links entirely ( #5112 )
...
* docs: clarify how to disable edit links entirely
* Update website/docs/api/plugins/plugin-content-docs.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-05 12:38:10 +02:00
Sébastien Lorber
364051f232
feat(v2): docs version banner configuration option ( #5052 )
...
* refactor DocVersionBanner => versionMetadata prop should be forwarded instead of using "useActiveVersion" + global data
* docs version banner configuration
* add doc for versions.banner
* fix tests
* improve docs plugin option api doc
2021-06-24 18:04:16 +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
Sébastien Lorber
32e76f1cc0
feat(v2): add docs pagination_label frontmatter ( #4982 )
...
* feat(v2): add docs pagination_label frontmatter
* feat(v2): add docs pagination_label frontmatter
* feat(v2): add docs pagination_label frontmatter
2021-06-16 12:03:46 +02:00
Alexey Pyltsyn
d7e4e422a2
docs(v2): minor tweaks ( #4981 )
2021-06-16 11:04:40 +02:00
Sébastien Lorber
737f80a026
fix(v2): sidebar_label should be used to compute next/previous button labels ( #4970 )
...
* sidebar_label should be used to compute next/previous button texts, as documented.
* improve docs frontmatter doc
* use a little bit of destructuring
2021-06-15 12:04:29 +02:00
Sébastien Lorber
57806798c5
fix(v2): fix contentTitle issues when markdown h1 title contains code blocks ( #4882 )
...
* attempt to fix contentTitle issues when markdown h1 title contains inline code blocks
* mention hide_title frontmatter only prevents frontmatter.title from being added in the dom (not a markdown # title in content)
* alwayss insert MainHeading under the div.markdown container for consistency
* ensure MainHeading has no useless id
* revert https://github.com/facebook/docusaurus/pull/4859 as it's now useless: docMeta.title contains the text/frontmatter title in priority over the contentTitle
* fix docs test after revert
* improve markdownParser and fix tests
* fix docs tests
* markdownParser: restore option to remove contentTitle (mostly for blog plugin)
* use removeContentTitle for blog
2021-06-03 17:45:19 +02:00
Sébastien Lorber
792f4ac6fb
feat(v2): allow user to customize/enhance the default sidebar items generator ( #4658 )
...
* allow and document how to wrap/enhance the default docusaurus sidebar items generator
* improve doc
* doc
* doc
2021-04-21 18:35:03 +02:00
