Joshua Chen
1481bc2eb7
docs: document doc tags + refinements ( #5433 )
...
* Various improvements
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Oops
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-30 11:03:03 +02:00
Antony Messerli
49c5f3ed41
docs: Add netboot.xyz to site showcase ( #5435 )
...
* Add netboot.xyz to site showcase
* Add files via upload
2021-08-30 10:27:28 +02:00
Rohit Gohri
c7f337e3b5
docs: add Redocusaurus in community plugin list ( #5436 )
...
Ref:
- https://github.com/facebook/docusaurus/issues/638#issuecomment-762502498
- https://github.com/rohit-gohri/redocusaurus
2021-08-28 21:25:37 +03:00
Sébastien Lorber
f600d5a6d7
chore: prepare v2.0.0-beta.5 release ( #5427 )
...
* beta.5
* v2.0.0-beta.5
2021-08-26 17:33:31 +02:00
Alexey Pyltsyn
0dd4892b0f
refactor: improve styles of Details component ( #5402 )
...
* refactor: improve styles of Details component
* Use vendor prefix for ::marker
* Wording
2021-08-26 16:46:35 +02:00
Alexey Pyltsyn
e6f4a9b231
docs: clarify using custom attributes for navbar link ( #5423 )
2021-08-26 14:29:05 +02:00
Joshua Chen
493225a3c6
feat(plugin-blog): multi-authors support + authors.yml global configuration ( #5396 )
...
* Complete function
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* A lot of blank lines
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More lenient validation
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove or
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Simpler logic
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Expand docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Better docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Dogfood
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* More writeup
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Polish
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Move mergeAuthorMap to authors.ts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Unbreak relative assets
* Update docs
* Clarify in docs
* simplify feed authors
* rename authorMap -> authorsMap
* mergeAuthorsMap -> getBlogPostAuthors
* website => 5 blog posts per page
* improve authors map file
* Extract new theme authors components + display in row
* add comment for meta array syntaxes
* blog => getPathsToWatch should watch authorsMap file
* remove useless v1 blog FBID frontmatter
* keep older frontmatter syntax for now
* revert blog frontmatter
* Better console message
* better blog authors frontmatter impl
* add multi authors to beta blog post + fix some authors margins
* fix React key
* Refactor: mdx loader should support a more flexible assets system (poc, not documented yet)
* better display of blog post authors: adapt layout to authors count + add line clamp
* smaller local image
* fix blog feed tests
* fix blog frontmatter tests + improve validation schema
* add more frontmatter tests
* add tests for getAuthorsMapFilePath
* tests for validateAuthorsMapFile
* add tests for readAuthorsMapFile
* test getAuthorsMap
* exhaustive tests for getBlogPostAuthors
* fix remaining tests
* missing blog plugin author tests
* fix windows tests
* improve blog multi-author's doc
* Use new format in init template
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Improve error message
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* update feed snapshot
* blog authors: limit to 2 cols + fix margins for no authors
* minor doc improvements
* better init template blog posts, demonstrating Blog features
* replace the legacy blog author frontmatter in remaining places
* Prefer using clsx
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* cleanup getColClassName
* remove blog author name/title line-clamping
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-26 12:21:58 +02:00
Fouad Matin
8779c8ff4a
docs: add Indent to showcase ( #5421 )
...
* docs: add Indent to showcase
* docs: add Indent preview
* fix: missing source field
2021-08-26 12:17:21 +02:00
Julien Neuhart
2a9f5903cf
docs: add Gotenberg to showcase ( #5405 )
2021-08-23 00:19:32 +03:00
Palash Shrivastava
b665b5b859
docs: specify proper min Node.js version in Travis CI example ( #5406 )
2021-08-23 00:13:53 +03:00
Sébastien Lorber
072a5a7e2e
fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching ( #5399 )
2021-08-20 19:37:20 +02:00
Sébastien Lorber
631c4685fb
chore: rename docusaurus-2-website package + refactor scripts ( #5397 )
2021-08-20 18:11:13 +02:00
Joshua Chen
8e1cde135c
feat: make blog config options and navbar versions dropdown label translatable ( #5371 )
...
* Translate versions dropdown label
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Make blog options tranlatable
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix names
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename functions
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Rename translations path
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update Chinese translations
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove space
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update docs
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Add jest test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix copyright typing
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Update options
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Fix test
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-20 17:11:59 +02:00
Deepak Prabhakara
69ec013248
docs(v2): showcase BoxyHQ ( #5390 )
2021-08-20 12:41:50 +02:00
Sébastien Lorber
f40ce05102
refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page ( #5389 )
...
* Better Canny integration
* Add missing netlify redirects
* polish
* TS doc: mention it's possible to use JSDoc in config
* issue templates: use /feature-requests new url
2021-08-20 11:42:13 +02:00
Isaac Philip
f9c79cbd58
feat: doc tags (same as blog tags) ( #3646 )
...
* [v2] tags to doc, same as tags to blog - [IN PROGRESS]
- Addition of plugin-content-docs
- Addition of DocTagsListPage in `docusaurus-theme-classic`
! Error exists for this commit towards the theme aspect and help required.
Commit towards #3434
* docs: make tags list page work
* temp: disable onBrokenLinks
* theme bootstrap: create DocTagsListPage
* DocTagsPage added and functionality too
- individual doc tag page added to show docs for that specific tag
* Added all Docs Tags Link
* add some shared tag utils
* move tag tests to _dogfooding
* fix type
* fix some tests
* fix blog test
* refactor blog post tags handling
* better yaml tag examples
* better dogfood md files
* refactor and factorize theme tag components
* finish DocTagDocListPage
* Extract DocItemFooter + add inline tag list
* minor fix
* better typings
* fix versions.test.ts tests
* add tests for doc tags
* fix tests
* test toTagDocListProp
* move shared theme code to tagUtils
* Add new theme translation keys
* move common theme code to tagUtils + add tests
* update-code-translations should handle theme-common
* update french translation
* revert add translation
* fix pluralization problem in theme.docs.tagDocListPageTitle
* add theme component configuration options
* add more tags tests
* add documentation for docs tagging
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-19 10:31:15 +02:00
Massoud Maboudi
f666de7e59
docs(v2): Update Datagit site to showcase page ( #5376 )
2021-08-18 15:10:14 +02:00
Sébastien Lorber
589a59ba8a
docs: remove docusaurus-preset-name from preset doc ( #5372 )
...
* doc: docusaurus-preset-name does not exist and is confusing for some users
* doc: docusaurus-preset-name does not exist and is confusing for some users
2021-08-17 19:38:35 +02:00
Paul O’Shannessy
8341527fc9
refactor: rename Git master branch to main ( #5345 )
...
* Prepare to renaming master branch to main
* Update CONTRIBUTING.md
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
* missing master -> main replaces
* useless char
* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required
* fix versioning page
* fix vercel links
* update deployment.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
Yan Ivan Evdokimov
03236e42ff
docs: Add drayman to showcase ( #5366 )
...
* Add Drayman to showcase.
* Re-run CLA check.
* Add navbar to image.
* Update website/src/data/users.tsx
Co-authored-by: slorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-08-17 13:19:05 +02:00
Joshua Chen
7d0272fe4d
feat(plugin-blog): allow 'ALL'
as postsPerPage
option value ( #5354 )
...
* 'ALL' option
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Guard against zero posts
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
* Remove redundant code
Signed-off-by: Josh-Cena <sidachen2003@gmail.com>
2021-08-17 13:07:18 +02:00
Garry
09a954165c
docs(v2): Add Nocalhost website to showcase page ( #5369 )
...
* add-nocalhost-to-showcase
* Update website/src/data/users.tsx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2021-08-17 12:06:45 +02:00
Sébastien Lorber
174fd2d248
docs(website): bump announcement bar + include Twitter link + refactor site colors ( #5351 )
...
* bump announcement bar + include Twitter link
* customize announcementBar css background + refactor infima colors
2021-08-13 16:23:56 +02:00
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