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

1235 commits

Author SHA1 Message Date
Ayush das
632b21bcf6
docs(v2): update installation docs (#5073) 
* docs: update installation docs to 2.0.0beta.2

* Update website/docs/installation.md

* Update website/docs/installation.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-29 10:20:41 +02:00
Rami Yushuvaev
3fe7389ee2
docs(v2:) Divide markdown-features/code-blocks to smaller sections (#5061) 
* Divide `markdown-features/code-blocks` to smaller sections

This PR adds few more heading to split the content to small topics.

This way users like me will be able to scroll directly to the specific section, instead of reading all the documentation.

I add to read the entire section because It was not divided into sections. Not a great user experience.

* Use `<h3>` heading
 2021-06-25 19:25:15 +02:00
bperlmutter
1d041127b1
docs(v2): correct typo (#5066) 2021-06-25 16:18:40 +02:00
Sébastien Lorber
ec2486d2c9
chore(v2): prepare v2.0.0-beta.2 release (#5056) 
* prepare beta.2

* v2.0.0-beta.2
 2021-06-24 19:39:37 +02:00
Sébastien Lorber
138b4c9975
fix(v2): allow undefined favicon (#5054) 
* fix(v2): allow undefined favicon

* fix snapshots
 2021-06-24 18:50:28 +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
Sébastien Lorber
9916a0b4a4
fix(v2): Fix announcementBar layout shifts (#5040) 
* Fix announcementBar layout shift

* useAnnouncementBar should return correct state after hydration

* refactor announcementBar => move utils to theme-common

* restore previous announcementBar

* typo
 2021-06-24 11:35:35 +02:00
Rami Yushuvaev
814455f88e
docs(v2): Fix Gatsby theme name for docs site - Docz (#5049) 2021-06-24 11:03:04 +02:00
Sébastien Lorber
119c6d143e
feat(v2): plugins injectHtmlTags + configureWebpack should receive content loaded (#5037) 
* more lifecycles should receive plugin loaded content

* refactor docs/blog plugins to use newly injected loaded plugin content instead of a mutable variable

* update lifecycle docs

* update lifecycle docs

* fix failing tests
 2021-06-22 17:36:51 +02:00
Sébastien Lorber
41eaa690ee
docs(v2): GH pages: recommend using trailingSlash (#5033) 2021-06-22 11:25:34 +02:00
Eshan Tripathi
425eccc5df
docs(v2): typo in deployment.mdx(#5030) 
Corrected a minor grammatical error
 2021-06-22 10:31:11 +02:00
Jules Sam. Randolph
53f6ee543d
docs(v2): Add React Native Render HTML site to showcase page (#5022) 2021-06-21 18:27:45 +02:00
Tomasz Papiernik
a865eb50b9
docs(v2): Add Buddy to deployment doc (#5027) 2021-06-21 18:15:01 +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
c63295a253
docs(v2): wrap mdx usage in mdx-code-block (#5007) 2021-06-18 17:59:51 +02:00
Sébastien Lorber
871e090ed8
chore: add archived versions system + archive alpha.73-75 (#5005) 2021-06-18 17:27:13 +02:00
Sébastien Lorber
8d8e5b67e8
chore(v2): prepare v2.0.0-beta.1 release (#5004) 
* beta.1

* v2.0.0-beta.1
 2021-06-18 16:54:46 +02:00
Alexey Pyltsyn
7dc9fe839b
chore(v2): update infima to alpha 26 (#5001) 2021-06-18 15:03:51 +02:00
Sébastien Lorber
b54ec72389
fix(v2): redirect plugin: use siteConfig.trailingSlash (#4988) 2021-06-16 19:04:28 +02:00
Sébastien Lorber
59f78f9084
docs(v2): document canary releases (#4987) 2021-06-16 16:11:41 +02: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
Lucas Correia
34411e12e5
fix(v2): truncate docuhash return value in order to avoid ERRNAMETOOLONG error (#4899) 
* fix: truncate docuhash return value in order to avoid ERRNAMETOOLONG error

* chore: add deep file path test page to website

* refactor: reorganize docuHash/pathUtils code and tests

* chore: git support longpaths on v2 windows tests workflow

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-06-15 18:39:06 +02:00
Joshua Chen
3d95a3e6b1
docs(v2): add documentation about importing code files (#4974) 
* Add documentation about importing code files

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

* Add warning about breaking API change

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

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-15 18:38:28 +02:00
Sébastien Lorber
9efa550cd5
docs(v2): mention to install the algolia package in search doc (#4976) 2021-06-15 16:14:03 +02:00
Alexey Pyltsyn
57cf20933e
feat(v2): add icon to external navbar links (#4949) 
* feat(v2): add icon to external navbar links

* use isInternalUrl

* Remove demo link

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-06-15 14:45:53 +02:00
Joshua Chen
02b512c2cf
docs(v2): add documentation about importing markdown (#4958) 
* Add documentation about importing markdown

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

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

* Run prettier

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

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-15 12:20:53 +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
Alexey Pyltsyn
4e5f0febb9
misc: disable google-gtag plugin in Netlify deploys (#4951) 2021-06-14 19:46:50 +02:00
e271828-
d2a5be8bd5
docs(v2): Add hCaptcha.com Docs to Showcase (#4957) 
* Add hCaptcha.com Docs

* Add files via upload
 2021-06-14 19:09:32 +02:00
Pablo Vidal
8d3e52f803
docs(v2): update Awe framework site showcase (#4963) 
We add i18n feature in Awe framework doc website
 2021-06-14 14:56:38 +03:00
Ben Rometsch
03ac9c2134
docs(v2): add Flagsmith to showcase (#4953) 
* Added docs.flagsmith.com

* Flagsmith image

* Update users.js

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
 2021-06-13 10:01:37 +03:00
Arthur
fea24e586e
docs(v2): add info about tabs DefaultValue prop (#4942) 2021-06-10 15:04:32 +02:00
Sébastien Lorber
b835aecaec
chore: removal of Docusaurus v1 code from master (it is now available on docusaurus-v1 branch) (#4902) 2021-06-10 10:54:07 +02:00
Sébastien Lorber
df8a900f9c
feat(v2): add trailingSlash config option (#4908) 
* POC: add trailingSlash option

* integrate the preferFoldersOutput option of fork @slorber/static-site-generator-webpack-plugin

* Fix broken links when using trailing slash => using md links is more reliable

* fix TS issue

* minor polish

* fix doc page being sensitive to trailing slashes

* Add tests for applyTrailingSlash

* rename test files

* extract and test applyRouteTrailingSlash

* update snapshot

* add trailing slash config to serve command

* fix getSidebar() => still sensitive to trailing slash setting

* never apply trailing slash to an anchor link

* Add documentation for trailingSlash setting
 2021-06-09 19:59:39 +02:00
Alexey Pyltsyn
55e9bd8ac9
refactor(v2): remove type attribute from link and script tags (#4907) 
* refactor(v2): remove type attribute from link and script tags

* minor TS fix

* stylesheets.type => optional

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-06-09 14:55:47 +02:00
Alexey Pyltsyn
869f4bf206
fix(v2): fix minor a11y issues (#4906) 2021-06-09 13:33:08 +02:00
silva-nick
aebfc45627
docs(v2): fix typo in code block on Using plugins page (#4910) 2021-06-05 17:24:45 +03:00
Alexey Pyltsyn
0cfdda81be
misc: optimize showcase images (#4901) 2021-06-03 19:37:10 +02:00
Jon Barker
0bdab02e20
docs(v2): add ClarityChallenge to showcase (#4898) 
* Update users.js

Adding a new user - ClarityChallenge.

* Add files via upload

* Update users.js

Fixing url for source of claritychallenge user
 2021-06-03 17:48:45 +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
phwt.smwt
0587d6d6e7
Fix incorrect link to plugin-ideal-image (#4896) 2021-06-03 12:20:59 +02:00
silva-nick
5e696a03bc
docs(v2): presets: fix typo in bootstrap preset (#4893) 2021-06-03 11:14:40 +02:00
Alexey Pyltsyn
35bdde3409
fix(v2): allow relative sidebar path resolution in docs:version command (#4861) 
* fix(v2): allow relative sidebar path resolution in docs:version command

* factorize sidebarPath option resolution logic + dogfood

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-06-02 18:21:45 +02:00
Louis Gallet
65cf8dacee
docs(v2): Add Aide Jeune website to Docusaurus site showcase (#4887) 
* Add Aide Jeune preview

* add aidejeune website

* correcting tags

* Add opensource tag

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
 2021-06-02 17:08:26 +02:00
Alexey Pyltsyn
08b94580e9
chore(v2): add external link to community sidebar (#4858) 2021-06-02 16:59:20 +02:00
Pranab Das
6d184a3e3d
docs(v2): New doc page for math equations (#4821) 
* New doc page for math equations

* improve math equations doc

Co-authored-by: slorber <lorber.sebastien@gmail.com>
 2021-06-02 14:55:50 +02:00
Sébastien Lorber
57a0a69137
docs(v2): v2 migration guide: mention Algolia config update (#4885) 2021-06-02 12:02:57 +02:00
Fardeen Panjwani
62caaeddbb
docs(v2): update steps in the github-actions section (#4876) 
* docs: update steps in the github-actions section

* refactor: format warning

* Update website/docs/deployment.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
 2021-06-01 18:05:26 +02:00