3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
4726 commits 46 branches 176 tags 870 MiB
Commit graph

70 commits

Author SHA1 Message Date
Joshua Chen
8d1c1954c1
refactor(content-blog): clean up type definitions; in-code documentation (#6922) 
* refactor(content-blog): clean up type definitions; in-code documentation

* add doc
 2022-03-16 19:36:57 +08: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
3fd99ad8d4
feat(content-blog): allow customizing blog archive component through option (#6603) 
* feat(content-blog): allow customizing blog archive component through option

* fix
 2022-02-04 18:56:09 +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
Tamal Web
ade486d079
docs: mention where to find the sitemap (#6492) 
* Added the sitemap url

So that users know where to locate their sitemaps

* Update plugin-sitemap.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2022-01-28 17:11:09 +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
59022c5eea
docs: add advanced guides (#6296) 
* docs: add advanced guides

* complete

* fix link

* Create architecture

* use png

* explanations

* more text

* process.env.NODE_ENV

* typo

* Add image zoom

* nit

* nit

* reorganize

* fix links

* fix links

* reorganize

* elaborate on presets

* fix

* routing docs

* ssr section

* more content

* complete SSR guide

* pathname://

* improvements

* document executionenvironment

* reformat

* final tweaks!

* avoid slug

* oops
 2022-01-25 11:29:18 +08:00
Joshua Chen
d506bca12d
feat(content-blog): allow disabling generating archive (#6415) 2022-01-20 14:52:19 +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
8fe1ddf46a
feat(sitemap): remove trailingSlash option; respect noIndex config (#6248) 2022-01-05 17:56:17 +01: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
e1bff072fe
feat(ideal-image): new option disableInDev (#6155) 
* feat(ideal-image): new option disableInDev

* Add docs

* Use import type

* More docs
 2021-12-25 21:48:38 +08:00
John Reilly
a17deb6aa2
docs: remove mention of 'UA-' in gtag (#6184) 2021-12-24 17:21:31 +08:00
Joshua Chen
dedf5ace5f
docs: normalize usage of placeholders (#6142) 2021-12-21 14:56:29 +01:00
不郑
7e5f6bb805
feat(content-blog): support json feed (#6126) 
* feat(content-blog): support json feed

* feat(content-blog): support json feed

* feat(content-blog): add json type to default feed options

* Refactors, docs, validation

* Fix test

* Ammend docs

* Add API doc

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2021-12-18 22:47:40 +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
Joshua Chen
ac88d979f1
refactor(ganalytics, gtag): move options out of themeConfig (#5832) 
* refactor(ganalytics, gtag): move options out of themeConfig

* Forbid themeConfig options

* Add PR link

* Add key names to error message

* Fix?

* Doc updates

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-11-10 19:04:43 +08: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
1c024470e0
feat(content-blog): allow sorting posts in ascending order (#5787) 2021-11-09 18:25:43 +01:00
Robbie Averill
2e85848487
docs: Minor update to grammar in plugins overview page (#5771) 2021-10-27 13:06:05 +02:00
Joshua Chen
9ad6de2b85
feat(content-blog): new readingTime plugin option (#5702) 2021-10-21 15:26:10 +02: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 &#124; by \|

* Keep `code`

* Apply suggestions from code review

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-09-08 14:58:48 +03: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
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
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
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
Joshua Chen
7d0272fe4d
feat(plugin-blog): allow 'ALL' as postsPerPage option value (#5354) 
* 'ALL' option

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Guard against zero posts

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Remove redundant code

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
 2021-08-17 13:07:18 +02:00
Sébastien Lorber
1257e99112
docs: try to make plugin/preset config less confusing (#5313) 2021-08-10 12:32:44 +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
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
Nazar
f14d8d2fdd
docs(v2): GIF format is not suported (#5133) 
https://github.com/facebook/docusaurus/issues/2956

Please check the issue above.
GIF format is currently is not supported
 2021-07-12 19:40:42 +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
Joshua Chen
af3640dca2
docs(v2): replace diff codeblocks with line highlight (#4973) 
* Replace `diff` codeblocks with line highlight

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Add line highlight
 2021-06-16 10:29:05 +02:00