Steven Hicks
9ead309809
docs: add clarity to versioning behavior ( #7327 )
2022-05-05 00:15:50 +08:00
Joshua Chen
785fed723f
refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar ( #7277 )
2022-05-04 12:08:19 +02:00
Joshua Chen
9fd5d62340
docs: enhance docs about Markdown TOC and metadata ( #7278 )
...
* docs: multiple documentation improvements
* fix
* fix
2022-04-30 21:30:14 +08:00
Joshua Chen
d2562a4434
refactor: normalize Markdown linkification behavior, elaborate in documentation ( #7248 )
...
* refactor: normalize Markdown linkification behavior, elaborate in documentation
* fix broken links
* allow links to be relative to site root
* fix test
* minor doc update
* Update website/docs/guides/markdown-features/markdown-features-links.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2022-04-29 11:36:39 +08:00
Andrew Lyons
ec109737e9
docs: explain more clearly the purpose of a ref sidebar type ( #7159 )
2022-04-12 15:59:41 +08:00
Leedom
b842197ac6
docs: consistently use sidebars.js filename ( #7016 )
...
* modify sidebar.js to sidebars.js in installation.md
* modify sidebar.js to sidebars.js
Co-authored-by: leedom <leedom@jinlanzuan.com>
2022-03-27 09:55:12 +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
Kayce Basques
284649c7c8
docs: clarify the usage of slug ( #6926 )
...
* Clarify the usage of slug
As a new user it was unclear whether setting `slug` would change the URL relative to the root directory or relative to the docs directory. The example I added should make that clear without needing to test out the functionality in a Docusaurus instance (which is what I had to do).
* editorial changes
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-17 07:54:18 +08:00
tae
2e163a9ec4
feat(content-docs): allow custom props through _category_.json ( #6780 )
...
* feat(content-docs): allow custom props through _category_.json
* refactor
* documentation
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-03-05 18:52:36 +08:00
Sébastien Lorber
12aae9a086
docs: add doc for generated-index keyword/image metadata ( #6708 )
2022-02-17 14:24:13 +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
TheCatLady
665d164351
feat(content-docs): add custom props front matter ( #6619 )
...
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-09 17:04:07 +01:00
BigDataWriter
bd05b74808
docs: improve wording of using Markdown file paths ( #6633 )
...
* Update docs-markdown-features.mdx
* Author meant to recommend the use of full paths rather than relative paths: Technical edit
* Revised intro to naturally introduce the benefits of this recommendation: Style edit
* Update website/docs/guides/docs/docs-markdown-features.mdx
* Update website/docs/guides/docs/docs-markdown-features.mdx
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-02-08 11:12:38 +08:00
Joshua Chen
0c4dc00443
feat(content-docs): allow omitting enclosing array consistently for category shorthand ( #6602 )
...
* feat(content-docs): allow omitting enclosing array consistently for category shorthand
* update snapshot
* fix doc
2022-02-04 11:16:08 +08: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
Jody Heavener
6ec0db4722
feat(content-docs): sidebar item type "html" for rendering pure markup ( #6519 )
...
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
2022-02-02 18:38:35 +01:00
Joshua Chen
3573b5e4a9
fix(content-docs): render category with no subitems as a normal link ( #6495 )
2022-02-02 14:45:00 +01:00
Joshua Chen
c1e3801ee7
fix(cli): allow passing a list of file names to write-heading-ids ( #6500 )
2022-01-29 12:21:15 +08:00
Joshua Chen
3c58d7f027
feat(content-docs): allow explicitly disabling index page for generated category ( #6452 )
...
* feat(content-docs): allow explicitly disabling index page for generated category
* docs
* add test
2022-01-27 23:14:07 +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
711a6fe3d0
docs: document embedding generated index in doc page ( #6453 )
...
* docs: document embedding generated index in doc page
* fix
2022-01-23 20:04:34 +08:00
Joshua Chen
01676329e1
docs: split sidebar documentation into sections ( #6450 )
...
* docs: split sidebar documentation into sections
* set slugs
* fix links
2022-01-23 17:50:48 +08:00
Joseph
8ce3cee400
feat(theme-classic): auto-collapse sibling categories in doc sidebar ( #3811 )
...
Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2022-01-20 16:38:16 +01:00
Joshua Chen
45f1b819b5
feat(content-docs): displayed_sidebar front matter ( #5782 )
2022-01-19 16:00:42 +01:00
Morooka Kotaro
4aaa48759d
docs: remove typo bracket ( #6327 )
...
* docs: remove typo bracket
* fix in latest version
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 15:13:50 +08:00
Nick Schonning
02a233a221
chore: minor typo cleanup ( #6324 )
...
* chore: minor typo cleanup
* fix tests
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-13 14:36:53 +08: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
4872decb42
docs: normalize CodeBlock highlighting ( #6223 )
2021-12-30 10:51:00 +08:00
Joshua Chen
6a772828c5
docs: add default value for BrowserWindow URL field ( #6207 )
...
* docs: fix BrowserWindow URL field
* fix
2021-12-28 15:19:23 +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
Himanshu
c0a99786b3
docs: elaborate on "docs-only" and "blog-only" ( #6131 )
...
* rephrased documentation
* Rewording
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-20 09:29:43 +08:00
Joshua Chen
18cb13d6cc
docs: refactor docs sidebar doc ( #6130 )
...
* docs: refactor docs sidebar doc
* Edits
2021-12-19 19:08:59 +08:00
Joshua Chen
7db4884853
refactor(website): make deploy preview open next version docs by default ( #6120 )
...
* refactor(website): make deploy preview open next version docs by default
* Fix links
2021-12-17 11:00:12 +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
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
Dmitriy Fishman
d7581b38fd
docs: Fix a typo in versioning.md ( #5852 )
2021-11-02 14:23:06 +08:00
Dominik Meyer
ab127e528d
doc: fix typo in "create a doc" ( #5818 )
...
* Update docs-create-doc.mdx
* Update docs-create-doc.mdx
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-10-29 14:48:36 +08:00
Joshua Chen
ae3596df39
docs: add h4 into toc on certain pages ( #5728 )
2021-10-19 20:15:11 +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
Kyriet
9a089d4886
docs: add note about partials on Create doc page ( #5543 )
2021-09-11 12:42:17 +03:00
swyx
194f429c1f
fix: add docs tag validation to solve #5478 ( #5479 )
...
* fix: add docs tag validation to solve #5478
fix: add docs tag validation to solve #5478
* Update docFrontMatter.ts
* Update docs-create-doc.mdx
* improve tag validation error messages + tests
* improve tags doc
* fix test
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-09-03 14:43:24 +02:00
Joshua Chen
1481bc2eb7
docs: document doc tags + refinements ( #5433 )
...
* Various improvements
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Oops
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-30 11:03:03 +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
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
cabb768473
feat: blog posts support /YYYY/MM/DD/blog-post/index.md pattern + blog frontmatter can reference relative images ( #5309 )
...
* POC of blog post folder
* add parseBlogFileName with tests + refactor and extract processBlogSourceFile in separate method
* improve blog date pattern doc + link from content plugin guides to API ref docs
* Some FrontMatter fields should be able to reference relative image assets, converted to Webpack require calls and exposed as frontMatterAssets
* remove log
2021-08-06 17:51:59 +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
