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
Joshua Chen
28e25992ab
feat: new init template classic-typescript ( #5233 )
...
* Add typescript template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Complete CLI
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove d.ts file
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Revert lock file changes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Regenerate lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add stylelint ignore
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Attempt to use symlink
* More symlinks
* Link all markdown
* Link source files
* Change to relative links
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix blogs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Link config
* Documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add option to index
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add option
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix copying
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Provide suffix
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Always have colored output
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove return signature
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update generate examples
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Use latest docusaurus
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update lock
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add type def
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* init: make classic first in list + mark as recommended + minor refactors
* remove types.d.ts
* add "yarn typecheck" script
* Minor tweaks
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Generate example for TS
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add comment
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* No emit when running tsc
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* FIx generate examples
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove compiler options
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* This looks better
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Use new tsconfig
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-06 19:11:36 +02:00
Sébastien Lorber
6b396055f8
fix: fix changelog page mdx import for i18n ( #5312 )
2021-08-06 19:09:29 +02:00
Sébastien Lorber
cabb768473
feat: blog posts support /YYYY/MM/DD/blog-post/index.md pattern + blog frontmatter can reference relative images ( #5309 )
...
* POC of blog post folder
* add parseBlogFileName with tests + refactor and extract processBlogSourceFile in separate method
* improve blog date pattern doc + link from content plugin guides to API ref docs
* Some FrontMatter fields should be able to reference relative image assets, converted to Webpack require calls and exposed as frontMatterAssets
* remove log
2021-08-06 17:51:59 +02:00
Sébastien Lorber
916b82119b
feat: mdx loader fallback, allow importing mdx docs from anywhere ( #5299 )
...
* move deep filepath test
* split markdownPageExample.md
* re-org dogfooding content
* Add mdx partials fallback synthetic plugin by default
* test commit
* hide changelog title as it's already included in the partial file
* trigger CI
* fix changelog sidebar label
2021-08-06 11:32:22 +02:00
Sébastien Lorber
81e6578fae
docs: update canary doc ( #5296 )
2021-08-05 14:38:48 +02:00
Sébastien Lorber
33b88ab717
fix: fix canary release versions ( #5285 )
2021-08-04 18:34:06 +02:00
Joshua Chen
c603056f66
docs: refactor API documentation ( #5219 )
...
* Refactor plugin-docs documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor theme-configuration
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Refactor plugin-blog docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* plugin-pages
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor change
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Interchange table columns
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fixes
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Minor improvements
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix hash link
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move blog front matter to API
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add more blog documentation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update blog.md
* Update blog.md
* Update blog.md
* Update website/docs/blog.md
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-04 16:35:17 +02:00
Alexey Pyltsyn
2c0b82e7ab
fix: apply proper class for active doc item on mobiles + avoid duplicated classes ( #5264 )
...
* fix: apply proper class for active doc item on mobiles
* Fixes after review
2021-08-04 15:29:10 +02:00
Marko Saric
2360c592ab
docs: Add Plausible Analytics docs to showcase page ( #5271 )
...
* Add Plausible Analytics docs to showcase page
* add plausible.png
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-04 14:18:33 +02:00
Alexey Pyltsyn
fdda2bd7fd
docs: fix broken link to syncing tab choices section ( #5283 )
2021-08-04 10:37:10 +03:00
Sébastien Lorber
bb825faf1c
fix: ability to link md files with relative paths when paths contain space ( #5270 )
...
* fix md linkify function when spaces in paths
* fix linkify
2021-08-02 18:02:01 +02:00
Sébastien Lorber
cdc41d5bb6
misc: enable pt-BR + archive older versions ( #5269 )
...
* add pt-BR to main site!
* archive older docs
2021-08-02 16:00:31 +02:00
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
