Commit graph

456 commits

Author SHA1 Message Date
Sébastien Lorber
ae988d0eb9
feat(v2): editUrl functions should receive md doc permalink (#4232) 2021-02-17 11:48:33 +01:00
Juan Carlos Blanco Delgado
2ff5d347ba
docs(v2): Removing wrong parenthesis on image variable (#4226)
* Removing wrong parenthesis on image variable

* Updating markdown feature documenation
2021-02-16 09:28:54 +01:00
Alexey Pyltsyn
0ac34b75c5
feat(v2): add support for RTL direction (#4140)
* feat(v2): add support for RTL

* Move to i18n config

* Move direction to localeConfigs

* Create RTL styles for Docusaurus styles (via new hook)

* update infima to alpha 19

* fix minor type error

* Fix build

* Cleanup

* polish RTL support

* polish RTL support

* revert english rtl dir

* minor RTL fix

* minor doc updates

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-10 10:52:26 +01:00
Alexey Pyltsyn
2fb642d9ee
feat(v2): allow extend PostCSS config (#4185)
* feat(v2): allow extend PostCSS config

* polish the configurePostCss system

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-09 20:02:54 +01:00
Alexey Pyltsyn
b3b658f687
feat(v2): allow to change location of search bar (#4199)
* feat(v2): allow to change location of search bar

* add SearchBar swizzle comment

* quickfix for NavbarItem theme config

* typing quickfix

* doc typo

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-02-09 16:31:52 +01:00
Sébastien Lorber
e3ae349889
docs(v2): localize 404 page with Netlify + docs (#4178) 2021-02-04 19:45:16 +01:00
Nahiyan Kamal
385d8b6315
docs(v2): typo fixing double colon (#4173) 2021-02-04 12:23:20 +01:00
Jessica Lin
4d3573dfcb
docs(v2): update check yarn installation command (#4170)
As listed `yarn version` doesn't work. According to [Yarn docs](https://classic.yarnpkg.com/en/docs/install#mac-stable), the command to check install should be `yarn --version`.
2021-02-04 01:15:52 +03:00
Alexey Pyltsyn
d25e0f4d0f
fix(v2): fix warning and improve styling inline TOC (#4163) 2021-02-03 12:11:42 +01:00
Sébastien Lorber
e807bff666
docs(v2): improve bad static assets doc + remove some useless useBaseUrl usage (#4158) 2021-02-02 18:26:51 +01:00
Nahiyan Kamal
f0f3de8008
docs(v2): guide docs typo fix (#4143) 2021-02-01 12:02:59 +01:00
Nahiyan Kamal
219a4b7b8c
docs(v2): plugins docs typo fix (#4141) 2021-02-01 12:01:56 +01:00
Nahiyan Kamal
aed23e2db5
docs(v2): remove unnecessary link from docs that looks like a duplicate (#4128) 2021-02-01 10:53:55 +01:00
TaeSeong Park
e53d63b769
docs(v2): Fix file path in "Wrapper your site with <Root>" (website/docs/using-themes.md) 2021-02-01 10:52:22 +01:00
Nahiyan Kamal
30c8e26a31
docs(v2): typo of Word Process (#4129) 2021-01-31 22:40:45 +03:00
Nahiyan Kamal
0c80fa824c
fix(v2): remove unnecessary brace from installation doc (#4127) 2021-01-31 22:39:55 +03:00
Nahiyan Kamal
6b194c6149
docs(v2): typo in i18n docs (#4130) 2021-01-31 22:38:44 +03:00
Sébastien Lorber
140bfbfd90
docs(v2): do not recommend using useBaseUrl() hook in most cases (#4126)
* doc: suggest not using useBaseUrl most of the time

* doc: suggest not using useBaseUrl most of the time
2021-01-29 19:10:38 +01:00
Sébastien Lorber
be7b5dca78
feat(v2): editUrl function for advanced use-cases (#4121)
* EditUrl function

* normalize blog/docs regarding the editUrl feature + editUrl function

* editUrl fn => always inject posix style relative paths, make tests more reliable
(see also https://github.com/facebook/docusaurus/issues/4124)

* fix editUrl on windows
2021-01-29 15:35:25 +01:00
Sébastien Lorber
671748f065
docs(v2): Do not encourage using the permalink prop (#4112) 2021-01-28 10:33:43 +01:00
Sébastien Lorber
869ebe7b53
fix(v2): fix/enhance minor i18n issues reported (#4092)
* fix comment

* allow to pass custom classname in navbar items

* Add IconLanguage comp to dropdown

* do not trim htmlLang

* Add initial hreflang SEO support

* doc hreflang
2021-01-22 21:26:42 +01:00
Sébastien Lorber
8a934ac9b7
docs(v2): Use the TOCInline component in config doc (#4084) 2021-01-21 18:41:52 +01:00
Sébastien Lorber
a8ee7fd3e8
docs(v2): i18n doc + polish (#4014)
* add some initial i18n doc

* i18n doc progress

* i18n tutorial progress

* i18n tutorial progress

* polish Crowdin docs

* i18n sidebar in guides

* polish crowdin doc

* update Crowdin doc a bit

* fix annoying relative link to global site resource in template (breaks i18n tutorial)

* template: use simpler export for homepage

* add markdown page example

* rename mdx.md to interactiveDoc.mdx

* update bootstrap/facebook templates too

* sync init template package scripts

* add slug frontmatter doc

* improve i18n doc

* complete i18n doc

* temporarily enable the localeDropdown

* doc typo

* improve the i18n doc

* Add Git i18n doc

* add missing "--" for npm run options (unfortunately they don't get stripped by npm2yarn, and are required foor npm)

* improve a bit the Crowdin doc
2021-01-19 17:26:31 +01:00
Sean Campbell
af8dc63202
docs(v2): add hideableSidebar option to config demo (#4009)
* docs: add hideableSidebar option to config demo

* Update docusaurus.config.js.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-01-19 17:17:02 +01:00
sammychinedu2ky
b93d95b9e0
docs(v2): Add codesandbox integration (#4062) 2021-01-19 16:00:07 +01:00
Reece Dunham
66cc7364cd
feat(v2): Allow plugins to consume webpack stats (#4021)
* refactor(v2): Allow plugins to consume webpack stats

Signed-off-by: Reece Dunham <me@rdil.rocks>

* Warn level only

* Fix issue

* Revert start.ts change
2021-01-11 15:34:42 +01:00
Vamsi Krishna Reddy Satti
d8ef2a9051
docs: fix typo from 'dissapear' to 'disappear' (#4022) 2021-01-10 13:20:28 +08:00
Theodore Chu
3ebe9cab68
docs(v2): Add how to run your own DocSearch (#4002) 2021-01-06 16:36:58 +01:00
Sean Campbell
da23912e7b
docs(v2): add overwriting css variables for dark mode (#3991) 2021-01-04 20:00:39 +01:00
Kumar Aditya
0bb5e547b1
feat(v2): skip dependency install on docusaurus init (#3986)
* fix: #3450

Signed-off-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>

* test: fix failing test

Signed-off-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2021-01-04 16:17:06 +01:00
Sébastien Lorber
d5d6e2fba2
docs(v2): Add documentation for docs multi-instance support (#3978)
* Add documentation for docs multi-instance support

* Add documentation for docs multi-instance support
2020-12-30 19:41:42 +01:00
Sébastien Lorber
d99d53a236
docs(v2): Reorganize/split the guides doc sections (#3975)
* docs reorg

* refactor docs/markdown features section

* fix broken links after docs refactor
2020-12-30 17:03:25 +01:00
Sébastien Lorber
e5610a475d
docs(v2): Add migration info doc regarding docs folder location (#3962) 2020-12-29 10:57:35 +01:00
Sébastien Lorber
141d062c3b
chore(v2): fix windows Jest tests (#3959)
* test(v2): Fix docusaurus-utils tests for windows

* test(v2): Fix plugin-client-redirects test

- add the posixPath in writeRedirectsFiles.ts

* test(v2): Fix plugin-content-pages test

add posixPath in test and index

* test(v2): add window test configuration

 - add the window test configuration in nodejs-windows.yml

* test(v2): revert plugin-content-pages test fix

* test(v2): Fix mdx-loader/transformImage test

* test(v2): add cleanPath in transformImage test

* fix version path tests for windows

* make versionMetadata test work on Windows

* try to fix posix/win32 path issues

* attempt to fix windows test

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* try to make source alias less win32 sensitive

* specific jest config for windows

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* attempt to fix windows testing issue

* remove bad cleanPath fn

* try to fix windows tests

* try to fix windows tests

* blog: try to fix windows tests by using same logic as on docs plugin

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* try to fix windows tests

* improve the Github CI setup for windows: make jobs run in parallel

* revert GH action change

Co-authored-by: Sachin Kumar Rajput <skr571999@gmail.com>
2020-12-28 19:50:12 +01:00
samhrncir
b54ec93c61
docs(v2): Update deployment.mdx (#3950)
Include documentation on environment variable needed for Enterprise GitHub Pages deployment.
2020-12-28 10:35:03 +01:00
Sébastien Lorber
b5c46bd1d9
feat(v2): new docs edit options: editCurrentVersion + editLocalizedDocs (#3949)
* editCurrentVersion initial poc

* ensure edit url allows to edit localized docs

* Add editLocalizedDocs option

* keep editing current version in dev (more convenient)
2020-12-28 10:25:47 +01:00
Matt Oestreich
2791ccc4cf
docs(v2): fix invalid JS example (#3952)
* Fix invalid json

* Update sidebar.md

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-12-25 18:20:35 +03:00
Siemienik Pawel
24ea18edf3
docs(v2): Added information about setting / in routeBasePath (#3945) 2020-12-22 16:25:33 +01:00
Sébastien Lorber
df47c1770c
feat(v2): Add <Root> theme element (#3932)
* Add <Root> component

* add some <Root> doc
2020-12-17 19:38:20 +01:00
Rami
5757cdc7a6
docs(v2): blog.md with docs: false, for blog-only mode (#3931)
Added ***docs: false,*** to the config for blog-only mode because we do not want any documents if we're in blog-only mode otherwise, we probably wouldn't use blog-only mode.
2020-12-17 19:24:04 +01:00
Varshit Shah
9626e547c9
docs(v2): Removed unnecessary closing parenthesis (#3924) 2020-12-16 16:44:47 +01:00
Arthur
109a4a7bbe
docs(v2): Move sidebar content to its own page (#3899)
* Move sidebar content to its own page

* Update website/docs/sidebar.md

* Fix merge conflict

* Fix note

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-12-11 17:02:32 +01:00
Sébastien Lorber
41ef333e47
feat(v2): inline table-of-contents + refactor TOC (#3904)
* Add TOCInline theme component

* Add TOCInline theme component doc + migration guide

* remove useless getPathsToWatch on classic theme

* rename rightToc to toc

* add temp theme-bootstrap TOCInline comp to fix build issue
2020-12-11 16:30:53 +01:00
Oliver Ullman
b11c24b752
feat(v2): add custom props for consumption by swizzled sidebar (#3888) 2020-12-10 19:49:21 +01:00
Cindy Gu
0b05806593
feat(v2): enable feeds by default in blog plugin (#3842)
* feat: enables feeds by default in blog

* feat(v2): enable feeds by default

committing a failed attempt for review

* feat(v2): enable feeds by default in blog plugin

- allow validation to work with arrays syntax
- using DEFAULT_OPTIONS.feedOptions.type instead

* feat(v2): enable feeds by default in blog plugin

- added documentation for feedOptions

* feat(v2): enable feeds by default in blog plugin

- modified implementation to allow feeds to be disable without error
- added unit test to ensure type: null leads to type: null after
  validation
- added documentation to explain how to disable feed generation
2020-12-10 18:35:19 +01:00
borool
dd8f3257a8
docs(v2): typo (#3856)
* Typo

That was written 2 times, I removed one "that"

* Update installation.md

* Update installation.md

* Update installation.md

* Update installation.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-12-10 17:13:23 +01:00
Alex1304
1f3f569f3e
docs(v2): wrap section about custom domains in :::info (#3891) 2020-12-07 19:02:01 +01:00
Sébastien Lorber
70dece09e6
docs(v2): missing <ColorGenerator/> mdx import (#3871) 2020-12-03 18:17:04 +01:00
Matteo Manzinello
20114f5e0a
docs(v2): From docusaurus-migrate to @docusaurus/migrate (#3873)
Fix from docusaurus-migrate to @docusaurus/migrate
2020-12-03 18:16:07 +01:00
Stephen Woodruff
aff17034cd
docs(v2): Fixed Typo: Hided => Hidden (#3851)
* Fixed Typo: Hided => Hidden

Fixed typo in section about the hideable sidebar. 'hided' is used instead of 'hidden'.

* Update docs.md

* Update docs.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-12-01 17:11:27 +01:00