Commit graph

1281 commits

Author SHA1 Message Date
Jonny Burger
778def2d8c
docs(v2): update Remotion website picture in showcase (#5259) 2021-07-30 20:07:56 +03:00
Dmitry Zhifarsky
ca8803146c
docs(v2): add Dart Code Metrics site to showcase page (#5260) 2021-07-30 20:05:42 +03:00
Forresst
d7e483557e
docs: Fix typo 2-resources.md (#5253)
Fix typo
2021-07-30 11:06:45 +02:00
Tunghsiao Liu
4beb218abe
docs(v2): add docusaurus-prince-pdf to resources (#5248) 2021-07-29 18:56:39 +02:00
David Seal
a59378ba87
docs(v2): Add unmand site to showcase page (#5239) 2021-07-29 17:36:12 +02:00
Sébastien Lorber
fc64c12e41
chore(v2): prepare v2.0.0-beta.4 release (#5238)
* chore(v2): prepare v2.0.0-beta.4 release

* update publish

* v2.0.0-beta.4
2021-07-28 22:54:41 +02:00
Sébastien Lorber
bb4d9c03e4
chore: enable pt-BR i18n locale on staging (#5237) 2021-07-28 22:31:46 +02:00
Sergio Moreno
d31f1be711
docs: add Verdaccio.org to showcase (#5236)
* chore: add Verdaccio.org to showcase

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-28 22:25:13 +02:00
Sébastien Lorber
b3e89d2a86
feat: docusaurus.new + improved StackBlitz playground (#5235)
* Upgrade playground shortcut domain to docusaurus.new

* update generateExamples

* update generateExamples + re-generate with stackblitz config

* test

* test

* test

* test

* test

* update examples

* upgrade lockfile

* fix yarnlock

* fix yarnlock
2021-07-28 19:27:58 +02:00
Sébastien Lorber
4cfbfa11ee
chore: Upgrade infima 29 (#5234)
Co-authored-by: Massoud Maboudi <massoud.maboudi@gmail.com>
2021-07-28 17:58:09 +02:00
Sébastien Lorber
dc4664b489
feat: details/summary theme / MDX component (#5216)
* Details component

* polish arrow animation

* fix text selection bug

* fix some edge cases + polish

* example of overriding baseClassName

* Move Details component to theme-common

* make component work even when JS is disabled or failed to load

* update arrow transform

* Details component: better handling of no-JS fallback mode: avoid delaying arrow navigation when JS (see review)

* prefix css vars with --docusaurus

* improve css arrow styling

* slightly change details/summary design

* better md doc + include quotes and details in doc
2021-07-27 18:45:12 +02:00
Alexey Pyltsyn
7e48961b3b
chore: fix iframe background color in dark mode (#5223)
* chore: fix GH button background color in dark mode

* Fix for Canny
2021-07-27 16:06:37 +02:00
Alexey Pyltsyn
b202fdb59f
docs(v2): remove vector.dev from showcase (#5218) 2021-07-25 16:24:41 +03:00
Sébastien Lorber
083037d7a5
refactor: redesign admonitions/callouts/quotes (#5193)
* prepare admonitions redesign

* Docusaurus admonition cleanup

* cover more edge cases in Docusaurus admonitions page: interleaving code blocks and links

* cover more edge cases in Docusaurus admonitions page: interleaving code blocks and links

* update Infima with new alerts
2021-07-23 17:10:38 +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
b38c35a36d
docs: mention Link can be used for external links (#5212) 2021-07-23 12:24:03 +02:00
Pranab Das
7b2d45a439
docs(v2): Elaboration of raw-loader in markdown react component (#5210)
* docs(v2): Elaboration of raw-loader in React component

* Add prettier ignore for a blocks to avoid unintended semicolon
2021-07-23 10:31:38 +02:00
Sébastien Lorber
700a82aefe
feat: multiple playground choices (#5207)
* poc of using netlify functions for playground redirections

* push

* cleanup

* restore files

* fix netlify functions?

* fix netlify functions?

* implement serverless functions for playgrounds with persistent cookie

* move new.docusaurus.io to monorepo packages

* move new.docusaurus.io to monorepo packages

* lockfile

* push

* catch-all redirect

* Translate/Interpolate: add better error message if not used correctly

* Add /docs/playground page

* Add some additional doc
2021-07-22 21:10:36 +02:00
Sébastien Lorber
4d06f26c1f
fix(v2): Fix MDX docs being considered as partials when siteDir match the _ prefix convention (#5199)
* Add _ to dogfood docs folder to cover against edge case

* Fix edge case with MDX partials when site / content dir contains a _ prefix

* add globUtils tests

* proper dogfooding folder re-organization, all content plugins being used

* refactor dogfooding folder + expose /tests page index

* fix page plugin ignoring options.routeBasePath
2021-07-21 14:13:51 +02:00
tohid nateghi
a2729128db
docs: user should restart docusaurus after adding prism additionalLanguage (#5191)
* Update markdown-features-code-blocks.mdx

if you add php language and don't restart your server, you will get an error like this

uncaught Error: Cannot find module './prism-php'

until you restart your server

* Update website/docs/guides/markdown-features/markdown-features-code-blocks.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-20 15:38:04 +02:00
Joshua Chen
f5f39fa8e0
docs: update API docs on navbar behavior (#5175)
* Document navbar dropdown behavior

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

* Partially done API documentation

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

* Complete API documentation

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

* Add deprecation warning

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

* Address suggestions

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

* Minor fixes

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

* Update website/docs/api/themes/theme-configuration.md

* Update website/docs/api/themes/theme-configuration.md

* Update website/docs/api/themes/theme-configuration.md

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-20 14:07:09 +02:00
Dan Gebhardt
966b1d18be
docs(v2): Add Orbit.js site to showcase (#5189) 2021-07-17 23:45:32 +03:00
David Barrat
6210509bbe
docs(v2): add easyjwt to users (#5177)
* docs(v2): add easyjwt to users

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-16 20:31:36 +02:00
Alexey Pyltsyn
54e4b02666
fix(v2): add base URL to content attribute of head tags PWA (#5185) 2021-07-16 11:56:00 +02:00
François Massot
cda09237cc
docs(v2): Add quickwit to user.js and png. (#5187)
* Add quickwit to user.js and png.

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-16 11:44:32 +02:00
Lukas Bach
5e8c62a074
docs(v2): Add react-complex-tree to users.js (#5184)
* add react-complex-tree to users.js

* add react-complex-tree preview image
2021-07-16 11:25:58 +02:00
Alexey Pyltsyn
f7b5e90390
refactor(v2): automatically add base URL to PWA head tags (#5169)
* refactor(v2): automatically add base URL to PWA head tags

* Add baseUrl only if necessary
2021-07-15 15:38:14 +02:00
Sébastien Lorber
81170a79f4
docs(v2): Update tutorial link (#5178) 2021-07-15 14:56:41 +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
Sébastien Lorber
38c6cb5faa
fix(v2): fix website PWA icon hrefs (#5167) 2021-07-14 16:42:12 +02:00
Arnaud Jeannin
2bd7f0d7a1
docs(v2): Update deploy with Qovery docs for V2 (#5158)
* Update deploy with Qovery docs for V2

Hello Docusaurus team,

I updated the docs for the new Qovery V2

https://www.qovery.com/blog/qovery-v2-beta-is-out

* run prettier on docs

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-14 11:26:42 +02:00
Sébastien Lorber
d3764f77fe
fix(v2): revert webpack.resolve.symlinks = false (#5164)
* WathcOptions should work even if Webpack does not resolve symlinks

* re-enable webpack resolve.symlinks = true

* Use symlinked folder as source
2021-07-13 20:11:08 +02:00
Raz Luvaton
d1f3a3631a
Open docs(v2): Indent code example to improve readability (#5152) 2021-07-13 10:09:19 +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
Alexey Pyltsyn
9536ef900d
feat(v2): redesign mobile UX: inline TOC + doc sidebar in main menu (#4273)
* feat(v2): mobile TOC

* Bug fixes and various improvements

* Redesign

* extract TOCCollapsible component

* TS improvements

* Assign sidebar name directly to the doc route => no need for either permalinkToSidebar or GlobalData

* revert changes to useWindowSize, fix FOUC issues

* extract DocSidebarDesktop component

* remove now useless menu infima classes

* TOCHeadings => rename + remove unused onClick prop

* Extract DocSidebarItem

* minor renaming

* replace GlobalData usage by a React teleport system to render in the navbar mobile sidebar menu directly from the DocPage component

* useWindowSize => simulate SSR size in dev to make FOUC issues more obvious

* fix remaining sidebar layout shift

* update docs snapshots

* remove unused code translations

* remove unused code translations

* fix minor update-code-translations bug

* Add more build-size paths to watch

* Restyle back button

* Add  missing`menu` class

* extract useShallowMemoizedObject

* fix routes tests + better routes formatting

* use Translate api for labels

* use Translate api for labels

* Update translations

* Improve dark mode support for back button

* Merge branch 'master' into lex111/inline-color-code

# Conflicts:
#	packages/core/dist/css/default-dark/default-dark-rtl.min.css
#	packages/core/dist/css/default-dark/default-dark.min.css
#	packages/core/dist/css/default/default-rtl.min.css
#	packages/core/dist/css/default/default.min.css

* replace useCollapse by new useCollapsible

* Cleanup and use clean-btn for TOCCollapsible button

* Make TOC links clickable over full width

* Cleanup

* fix uncollapsible sidebar that can be collapsed + create <Collapsible> component

* dependency array typo

* rollback sidebars community commit typo

Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-07-09 16:50:38 +02:00
Sébastien Lorber
f03479f69e
test(v2): dogfooding: add huge sidebar for testing purposes (#5130)
* dogfoog: add huge sidebar for testing purposes

* Add standalone doc + build-size tracking
2021-07-08 20:26:55 +02:00
Sébastien Lorber
dc9f104ccc
fix(v2): remove webpackConfig.resolve.symlinks: true (#5126)
* remove webpackConfig.resolve.symlinks: true

* Add docs-test docs plugin instance to validate using a symlink folder as docs source is possible

* comment

* useful comments
2021-07-08 18:59:56 +02:00
Arijit Kundu
a7b23d94d0
docs(v2): Add Zowe to Showcase (#5121) 2021-07-08 14:40:59 +02:00
Taylor Reece
ef70de18dd
docs(v2): Add Prismatic docs page to showcase. (#5117) 2021-07-06 19:52:44 +02:00
David Zhao
067f3dac7e
docs(v2): Add LiveKit to showcase (#5115)
* added LiveKit to showcase

* Update website/src/data/users.js

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-07-06 14:45:24 +02:00
Przemysław Chojecki
e5bfa2ede2
docs(v2): add Blink Shell Documentation to Showcase (#5114) 2021-07-06 11:48:35 +03: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
Philipp Muens
c9d4854ad8
docs(v2): Add CryptoDevHub to Showcase (#5113) 2021-07-05 10:50:54 +02:00
Sébastien Lorber
1ec2c95e3d
chore(v2): prepare v2.0.0-beta.3 release (#5098)
* beta.3

* publish guide

* publish guide

* v2.0.0-beta.3
2021-06-30 16:05:49 +02:00
Rami Yushuvaev
9b9f38cd50
docs(v2): Rewrite markdown images section (#5064)
* Rewrite markdown images section

Before it looked like we have two ways to display images, now it's three ways. Each syntax has a separate example.

This way it's clear, I see each method and the code example.

Before there were 2 methods in a single code block.

* fix typo in `markdown-features/markdown-features-assets`

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Rewrite image display section using CommonJS require

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* Rewrite image display section using ES imports

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>

* prettier doc

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-06-30 15:27:44 +02:00
dirslashls
b499331625
docs(v2): Add SQL Frames to the showcase (#5086)
* Update users.js to add SQL Frames to the showcase

* Adding image to showcase
2021-06-30 11:15:58 +02:00
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