Commit graph

434 commits

Author SHA1 Message Date
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
davidmauskop
821a39bf2e
docs(v2): render deployment doc (#3813)
Link to Render's deployment guide
2020-11-30 14:46:27 +01:00
Bartosz Kaszubowski
e864aa02aa
docs(v2): update Client API docs page (#3835)
* docs(V2): update Client API docs page

* apply review suggestion, fix useGlobalData example
2020-11-30 14:39:51 +01:00
Sébastien Lorber
8f47babb46
docs(v2): Docs refactoring and reorganization (#3831)
* stable refactor of plugins api documentation

* plugins sidebar not collapsed by default as small?

* theme docs reorg

* Refactor migration guide doc

* fix broken link
2020-11-30 14:07:08 +01:00
Sébastien Lorber
f1bed8dd69
fix(v2): Algolia: allow contextualSearch + facetFilters (#3804)
* remove contextualSearch facetFilters  merging security

* update doc
2020-11-23 19:43:38 +01:00
Sébastien Lorber
746a19f25b
feat(v2): add baseUrlIssueBanner configuration to disable banner (#3802)
* add baseUrlIssueBanner configuration

* handle review
2020-11-23 20:54:13 +03:00
Sébastien Lorber
9e314bcb11
docs(v2): fix Docusaurus init issue when not using @latest (#3803) 2020-11-23 20:24:11 +03:00
Sébastien Lorber
533bc6ad9a
docs(v2): recommend Docusaurus 2 usage (#3785)
* recommend using Docusaurus v2

* Little improvements

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-11-21 15:42:56 +03:00
Sébastien Lorber
4fbece2383
docs(v2): remove @next tags + minor docs changes (#3783) 2020-11-19 12:48:18 +01:00
camiluc
7d4510b686
docs(v2): rename zeit to vercel (#3781) 2020-11-19 12:43:38 +01:00
Kaartic Sivaraam
118c76b47c
docs(v2): doc typo (#3776) 2020-11-18 16:42:50 +01:00
Alexey Pyltsyn
30d7408815
refactor(v2): various markup improvements (#3763) 2020-11-17 02:15:22 +03:00
David Goss
bb64f68acd
docs(v2): add npm2yarn to TypeScript install command (#3750) 2020-11-15 01:08:38 +03:00
Bartosz Kaszubowski
9d90e896f0
feat(v2): add ThemedImage component (#3730)
* feat(v2): add ThemedImage component

* add themed image problematic example

* refactor, SSR fix, openness about extending img tag, docs update

* refactor themed-image

* update themed image doc

Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-11-13 14:29:45 +01:00
Bartosz Kaszubowski
74ee8f6150
docs(v2): add Inline SVG color override example (#3737) 2020-11-13 14:17:22 +01:00
Alexey Pyltsyn
487a9f98e4
feat(v2): introduce new minification of CSS bundle (#3716)
* feat(v2): optimize CSS bundle

* Move to separate preset

* Move custom scrollbar styles to separate class

* Cleanup styles

* Remove unactual styles

* Various CSS optimizations, cleanup styles for NProgress

* Add ability to back to old way of minifying CSS

* chore(v2): downgrade babel-plugin-dynamic-import-node to 2.3.0

* Use env var for back to simple CSS minifier

* remove unnecessary typing [skip-ci]

* Remove missing dep

* Update website/docs/cli.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-11-13 14:06:24 +01:00
Alexey Pyltsyn
8ef7c24583
fix(v2): use swizzled SearchPage component if any (#3721)
* fix(v2): use swizzled SearchPage component if any

* Fix dependency cycles warning
2020-11-12 17:01:46 +01:00
Alexey Pyltsyn
8c9f9487d6
refactor(v2): render all tab panels at once (#3706)
* refactor(v2): render all tab panels at once

* Add ability to choose way to load tabs
2020-11-09 17:06:07 +01:00
Alexey Pyltsyn
498f8a0f27
chore(v2): adjust website npm package (#3709) 2020-11-09 15:28:18 +01:00
Stephen McElhinney
9309594da9
feat(v2): Added the ability to specify GIT_PASS in deploy command (for CI purposes) (#3694)
* Added the ability to specify GIT_PASS (for CI purposes)

* Fixed variable copy issue

* Added documentation for GIT_PASS

Co-authored-by: Stephen McElhinney <stephen@appstruct.io>
2020-11-09 13:13:10 +01:00
Sébastien Lorber
c22c132fe0
docs(v2): deployment should use mdx extension (#3699)
* deployment: make it a mdx component because it contains <Tabs>

* fix deployment md links

* typo

* fix more links
2020-11-05 18:22:18 +01:00
iAmir
8f2d898f22
feat(v2): onBrokenMarkdownLinks config (#3658)
* refactor(v2): move `reportMessage` from `core/src/server/utils` to `utils` package

* feat(v2): handle broken markdown links by using onBrokenLinks prop from siteconfig

* feat(v2): add a new site config prop called `onBrokenMarkdownLinks`

works like onBrokenLinks, but only for markdown links

* feat(v2): add `onBrokenMarkdownLinks` to API docs

* some changes regarding test issues after adding `onBrokenMarkdownLink`

* Update website/versioned_docs/version-2.0.0-alpha.66/api/docusaurus.config.js.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-10-31 18:04:56 +01:00
kenve
4f64da8eda
docs(v2): update the link of Joi (#3644) 2020-10-27 15:03:17 +03:00