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
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
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
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
Alexey Pyltsyn
fdda2bd7fd
docs: fix broken link to syncing tab choices section ( #5283 )
2021-08-04 10:37:10 +03: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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Arthur
fea24e586e
docs(v2): add info about tabs DefaultValue prop ( #4942 )
2021-06-10 15:04:32 +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
