3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-08 06:37:18 +02:00
Code Issues Projects Releases Packages Wiki Activity
3999 commits 47 branches 176 tags 885 MiB
Commit graph

1343 commits

Author SHA1 Message Date
Kyriet
9a089d4886
docs: add note about partials on Create doc page (#5543) 2021-09-11 12:42:17 +03:00
Robert Kingston
0f5efc976f
docs: Add Mint Metrics site to the Showcase (#5549) 
Co-authored-by: Robert Kingston <rob@mintmetrics.io>
 2021-09-11 12:38:38 +03:00
Ivar Conradi Østhus
83b05772d5
docs: add Unleash to showcase (#5546) 
* docs: add unleash to showcase

* Fix URL

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-09-09 13:11:59 +03: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
Sébastien Lorber
4f59f0782e
docs: mention Netlify ignore build setting (#5486) 
* mention Netlify ignore build setting

* doc backport
 2021-09-03 19:34:10 +02:00
Daniel Costrasel
09a7e0b00b
docs: update docusaurus-plugin-relative-paths description (#5482) 2021-09-03 14:44:34 +02: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
Sébastien Lorber
fd3c0c6619
chore: remove beta.4 docs (already archived) (#5474) 2021-09-02 18:56:22 +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
Daniel Costrasel
e5d9ff18a8
docs: Add docusaurus-plugin-relative-paths (#5471) 2021-09-02 17:18:50 +02:00
Oscar Lorentzon
9918c3c45e
docs: add mapillary-js to showcase (#5464) 2021-09-02 16:08:59 +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
d76091c7fe
fix: website bad version name in docusaurus.config.js (#5455) 2021-08-31 17:40:47 +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
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
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
Antony Messerli
49c5f3ed41
docs: Add netboot.xyz to site showcase (#5435) 
* Add netboot.xyz to site showcase

* Add files via upload
 2021-08-30 10:27:28 +02:00
Rohit Gohri
c7f337e3b5
docs: add Redocusaurus in community plugin list (#5436) 
Ref: 
- https://github.com/facebook/docusaurus/issues/638#issuecomment-762502498
- https://github.com/rohit-gohri/redocusaurus
 2021-08-28 21:25:37 +03: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
Alexey Pyltsyn
e6f4a9b231
docs: clarify using custom attributes for navbar link (#5423) 2021-08-26 14:29:05 +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
Fouad Matin
8779c8ff4a
docs: add Indent to showcase (#5421) 
* docs: add Indent to showcase

* docs: add Indent preview

* fix: missing source field
 2021-08-26 12:17:21 +02:00
Julien Neuhart
2a9f5903cf
docs: add Gotenberg to showcase (#5405) 2021-08-23 00:19:32 +03:00
Palash Shrivastava
b665b5b859
docs: specify proper min Node.js version in Travis CI example (#5406) 2021-08-23 00:13:53 +03:00
Sébastien Lorber
072a5a7e2e
fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching (#5399) 2021-08-20 19:37:20 +02:00
Sébastien Lorber
631c4685fb
chore: rename docusaurus-2-website package + refactor scripts (#5397) 2021-08-20 18:11:13 +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
Deepak Prabhakara
69ec013248
docs(v2): showcase BoxyHQ (#5390) 2021-08-20 12:41:50 +02:00
Sébastien Lorber
f40ce05102
refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (#5389) 
* Better Canny integration

* Add missing netlify redirects

* polish

* TS doc: mention it's possible to use JSDoc in config

* issue templates: use /feature-requests new url
 2021-08-20 11:42:13 +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
Massoud Maboudi
f666de7e59
docs(v2): Update Datagit site to showcase page (#5376) 2021-08-18 15:10:14 +02:00
Sébastien Lorber
589a59ba8a
docs: remove docusaurus-preset-name from preset doc (#5372) 
* doc: docusaurus-preset-name does not exist and is confusing for some users

* doc: docusaurus-preset-name does not exist and is confusing for some users
 2021-08-17 19:38:35 +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
Yan Ivan Evdokimov
03236e42ff
docs: Add drayman to showcase (#5366) 
* Add Drayman to showcase.

* Re-run CLA check.

* Add navbar to image.

* Update website/src/data/users.tsx

Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-08-17 13:19:05 +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
Garry
09a954165c
docs(v2): Add Nocalhost website to showcase page (#5369) 
* add-nocalhost-to-showcase

* Update website/src/data/users.tsx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-08-17 12:06:45 +02:00
Sébastien Lorber
174fd2d248
docs(website): bump announcement bar + include Twitter link + refactor site colors (#5351) 
* bump announcement bar + include Twitter link

* customize announcementBar css background + refactor infima colors
 2021-08-13 16:23:56 +02:00
Erick Zhao
c76dfb8a2c
docs: update docusaurus-plugin-sass instructions (#5352) 
The `docusaurus-plugin-sass` plugin has `sass` as a peer dependency, so you
need to install that package as well, as per their README.
 2021-08-13 12:47:13 +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
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
Sébastien Lorber
a2ab4d33c8
feat: Markdown page-specific head metadatas (#5330) 
* Markdown page-specific head metadatas

* ensure mdxType attribute is not added to the final markup

* polish doc

* Update packages/docusaurus-theme-classic/src/theme/MDXComponents/index.tsx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* fix eslint annoying rule error

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
 2021-08-11 11:39:01 +02:00
Joshua Chen
6c21061e34
refactor(website): convert website to TypeScript (#5328) 
* Initial work

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

* Minor changes

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

* Fix error

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

* This looks better

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

* Address suggestions

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

* Better style

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

* Better style

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

* Better context typing

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

* Update edit URL

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

* Minor refactor

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
 2021-08-11 11:38:33 +02:00
Alexey Pyltsyn
09f089b612
chore: upgrade Infima to alpha.30 (#5256) 
* chore: upgrade Infima to alpha.30

* Remove redundant CSS class

* Update index.tsx
 2021-08-11 10:56:57 +03:00
Sam Wall
10ac9a6f2a
docs: add mdx-mermaid to resources (#5332) 2021-08-11 09:44:09 +03:00
Sébastien Lorber
49715d7a36
docs: Changelog page should display TOC with releases (#5331) 2021-08-10 19:56:41 +02:00
HaochenQ
58a8b0ea2c
docs: add Haochen to showcase page (#5329) 
* Update users.js

Adding my website built with docusaurus as a showcase.

* Add files via upload

Add an image preview.
 2021-08-10 16:23:36 +02:00
Sébastien Lorber
1257e99112
docs: try to make plugin/preset config less confusing (#5313) 2021-08-10 12:32:44 +02:00