8304e8253c
docs(v2): Fix typo in markdown-features ( #2973 )
...
* Fix typo in markdown-features
The code needed to be in npm syntax in order to work with npm2yarn
* Update markdown-features.mdx
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
2020-06-25 17:05:51 +02:00
20930dc837
docs(v2): add plugin redirects production build note ( #2983 )
...
* add plugin redirects production build note
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-06-24 20:13:32 +02:00
81d855355e
feat(v2): option and config validation life cycle method for official plugins ( #2943 )
...
* add validation for blog plugin
* fix wrong default component
* fix test and add yup to package.json
* remove console.log
* add validation for classic theme and code block theme
* add yup to packages
* remove console.log
* fix build
* fix logo required
* replaced yup with joi
* fix test
* remove hapi from docusuars core
* replace joi with @hapi/joi
* fix eslint
* fix remark plugin type
* change remark plugin validation to match documentation
* move schema to it's own file
* allow unknown only on outer theme object
* fix type for schema type
* fix yarn.lock
* support both commonjs and ES modules
* add docs for new lifecycle method
2020-06-24 20:08:16 +02:00
ce10646606
document that docs/blog-only modes should delete the existing homepage
2020-06-23 18:29:19 +02:00
4aa77651d3
docs(v2): update docs about creating a new plugin #2963
2020-06-19 15:32:36 +02:00
56067e4add
docs(v2): fix typos in plugin-content-pages example ( #2967 )
2020-06-19 14:17:28 +08:00
162870d251
docs: mention posthog-docusaurus plugin ( #2957 )
2020-06-18 19:30:42 +08:00
d365b7424b
docs(v2): add useThemeContext note ( #2934 )
...
* docs: add note to useThemeContext api docs
* Update example usage
2020-06-15 12:39:17 +02:00
c341f457fb
docs(v2): add router implementation note ( #2935 )
2020-06-15 12:37:49 +02:00
8eed245000
docs(v2): add documentation for multiple blogs ( #2933 )
...
* docs(v2): add documentation for multiple blogs
* docs(v2): fix typos of docusaurus
* docs(v2): make the same changes in the latest version of documentation
* docs(v2): remove an empty blockquote
* docs(v2): improve documentation for multiple blogs
2020-06-15 03:18:37 +08:00
729b3cae9b
feat(v2): Allow configuring babel via babel.config.js ( #2903 )
...
* feat(v2): Allow configuring babel via docusaurus.config.js
* Use api.caller feature from babel to avoid expose isServer to users
* Remove unused optional config key
* Make babel loader resolve and require config file
2020-06-12 11:03:00 +08:00
68a1bb1ebf
Merge pull request #2793 from slorber/feature/client-side-redirects
...
feat(v2): docusaurus-plugin-client-redirects
2020-06-10 17:36:57 +02:00
3e43955df6
docs(v2): fix typo in ExecutionEnvironment example
2020-06-09 21:52:24 +08:00
c97fd9f1d7
docs(v2): fix GitHub action workflow in documentation ( #2910 )
2020-06-09 16:29:55 +08:00
afe9ff91a4
chore(v2): replace classnames with clsx ( #2895 )
2020-06-07 13:40:06 +08:00
1003a15d1f
polish(v2): improve Docusaurus 1 to 2 migration developer experience ( #2884 )
...
* improve markdown parsing errors by adding file path to error
* typo commit
* Add default nav item position to right (as v1)
* improve error when sidebar references unexisting document
* parseMarkdownFile: improve errors by providing hint about using "" to avoid parsing errors, if using special characters
* improve subcategory migration error for Unknown sidebar item type
* improve unrecognizedFields error
* typo
* fix inline snapshots
* improve the migration docs
* improve the migration docs
* improve migration doc
* Update migrating-from-v1-to-v2.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-06-06 11:16:50 +08:00
8aa520c314
fix(v2): Do not automatically change tab when a non-existing option is selected ( #2893 )
2020-06-06 11:11:42 +08:00
4278cebf67
docs(v2): fix typo in command on installation page ( #2886 )
...
* Fix installation.md typo
Checking the docusaurus version should be done with
```
npx docusaurus --version
```
not
```
npm docusaurus --version
```
otherwise it prints the version of `npm` instead of `docusaurus`.
* docs: Fixed installation.md for checking version.
Specifying `npm` for the version will yield the version of NPM
instead of docusaurus itself. Use `npx` for the docusaurus version.
2020-06-06 04:14:53 +03:00
2d8abe150f
docs(v2): make .nojekyll warning more obvious ( #2887 )
2020-06-05 10:22:06 +08:00
953abd8154
feat(v2): allow adding components to react-live scope ( #2826 )
...
* feat(v2): add components to react-live scope (#2807 )
* fix admonition issue + improve react-live scope doc
* fix again admonition :(
* remove forwarding of mdx components to react-live scope (for now)
* remove useless dep
2020-06-04 15:18:42 +03:00
f6d1b2b9ca
add type comments to createRedirects doc
2020-06-03 20:09:56 +02:00
812daa8af5
improve doc
2020-06-03 18:13:10 +02:00
4e8b361d00
remove github pages mention for server-side redirects
2020-06-03 15:17:02 +02:00
802235c768
Merge branch 'master' into feature/client-side-redirects
2020-06-03 15:16:24 +02:00
c251eaf7b8
Update website/docs/using-plugins.md
...
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-03 12:55:09 +02:00
504b1b4443
Update website/docs/migrating-from-v1-to-v2.md
...
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-03 12:54:41 +02:00
e68b81bc33
fix(v2): do not create route for document that serve as docs home page ( #2861 )
2020-06-03 15:56:57 +08:00
b8de9c6ded
feat(v2): introduce docs slug in front matter ( #2771 )
...
* feat: docs pathname frontmatter (for #2697 )
* feat: docs pathname frontmatter (for #2697 )
* chore: comment typo
* feat: add slug frontmatter for docs
* test: add tests for versioned sites slugs
* docs: document slug feature
* test: fix tests and snapshots about doc slug feature
* docs(v2): doc slug wording
* Update website/docs/docs.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-02 20:50:30 +03:00
ed9977accc
docs(v2): description field in frontmatter of blog post ( #2865 )
2020-06-02 11:02:45 +03:00
c0c7457e01
feat(v2): allow specifying meta image for blog posts ( #2856 )
...
* feat(v2): allow specifying meta image for blog posts
* Update docs [skip ci]
2020-06-02 10:48:22 +03:00
67f88c12e7
doc typo
2020-06-01 17:38:49 +02:00
b8168e2287
document @docusaurus/plugin-client-redirects in migration guide + fix doc typo
2020-06-01 17:33:20 +02:00
7cba7f0d06
docs(v2): _index docs page does not show a sidebar ( #2839 )
...
* docs: _index docs page does not show a sidebar
Closes #2836
* Update website/docs/docs.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-06-01 14:06:02 +03:00
93b35afe95
feat(v2): Allow swizzling prism-include-languages in theme-classic ( #2841 )
...
* feat(v2): Allow swizzling prism-include-languages in theme-classic
* Add docs
* Improve docs
2020-05-31 14:41:16 +08:00
ce4b0187aa
docs(v2): Update ZEIT to Vercel ( #2842 )
...
docs: update ZEIT to Vercel
2020-05-30 13:35:22 +08:00
768ed7368b
Merge branch 'master' into feature/client-side-redirects
2020-05-28 16:11:58 +02:00
07b9e9cd62
feat(v2): expanded sidebar categories by default ( #2682 )
...
* feat: update sidebar categ to take collapsed prop
* feat: add extra sidebars collapsed test
* fix: only mutate item.collapsed if necessary
* feat: update docs for SidebarItemCategory
* fix: update snapshots
* fix: update json to match new sidebar schema
* fix: update last snapshot
* refactor: check if item should be expanded
* docs: update sidebar categories section
* refactor: use new collpased on docusaurus
* feat: only highlight category for active page
* fix: check for window
* refactor: use ExecutionEnviornment
* refactor: make isCategoryOfActivePage pure
* fix: rename docs to docs-introduction in sidebars
* Update docs.md
* misc: remove setting for every sidebar
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-05-28 13:17:19 +08:00
33b60c6ba4
fix(v2): Consistently use 10.15.1 as the minimum required node version ( #2819 )
2020-05-27 23:18:48 +08:00
362573a391
Merge branch 'master' into feature/client-side-redirects
2020-05-27 16:51:04 +02:00
082c6212cb
feat(v2): allow deploy without building website ( #2770 )
...
* feat(v2): allow deploy without building website
* Update cli.md
2020-05-27 22:34:41 +08:00
d6afb44082
add doc for @docusaurus/plugin-client-redirects
2020-05-27 16:14:18 +02:00
2105700fb7
refactor(v2): various tweaks to website ( #2816 )
2020-05-27 20:56:59 +08:00
4cc36a535e
docs(v2): add trailing slash to external links ( #2801 )
2020-05-24 19:46:23 +08:00
2dbd0488d7
docs(v2): document beforeDefaultRemarkPlugins and beforeDefaultRehypePlugins
2020-05-23 06:12:24 +08:00
1503943e3f
fix(v2): Use `require.resolve` to resolve plugin path in presets ( #2794 )
2020-05-23 04:57:02 +08:00
e6cdeba603
docs(v2): add articles section to resources page ( #2781 )
2020-05-22 11:26:29 +08:00
7448501c7c
refactor(v2): make external links more secure ( #2783 )
2020-05-22 11:18:27 +08:00
0dc0c35ec8
docs(v2): misc update
2020-05-20 11:41:39 +03:00
fc161b8455
docs(v2): various improvements ( #2768 )
2020-05-18 11:37:53 +08:00
8e24454154
feat(v2): allow import SVG images ( #2764 )
2020-05-18 11:18:02 +08:00
6db5e8dff8
docs(v2): add deployment workflow manual for GitHub Actions ( #2670 )
...
* docs: add deployment workflow manual for GitHub Actions
Steps to build and deploy Docusaurus with GitHub Actions
* docs(v2): improve formatting
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-05-18 11:07:48 +08:00
d145f03ea8
refactor(v2): change the label for docs introduction ( #2716 )
...
* change the label for docs introduction
* change file id
* refactor(v2): change name
2020-05-17 19:29:57 +08:00
daafd2f0cc
feat(v2): allow activeBaseTest in NavLink ( #2690 )
...
* Update documentation, add support for activeBaseTest
* Implicit else
* Fix Regular Expression capitalization
Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>
* Refactor isActive to ternary function, rename activeBaseTest to activeBaseRegex
* Update website/docs/theme-classic.md
Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>
* Fix typo
* Update website/docs/theme-classic.md
Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>
* Update theme-classic.md
Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
2020-05-17 19:23:32 +08:00
00a8e9e365
feat(v2): allow home page for docs ( #2652 )
...
* feat(v2): allow home page for docs
* Refactor
* Remove debugging info 🤦♂️
* Add sort routes for first test case
* Sort child routes for consistency
2020-05-17 17:48:02 +08:00
3a2f150093
docs(v2): change fanny's description ( #2757 )
...
* feat(v2): change fanny's description
* Update team.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-05-17 12:37:45 +08:00
78add75057
docs(v2): fix typo in deployment ( #2755 )
2020-05-16 15:03:27 +08:00
9c94dd7c86
docs(v2): typo in creating page ( #2753 )
2020-05-16 01:16:05 +08:00
c117a6fe79
docs(v2): update team page
2020-05-14 13:52:01 +08:00
cfd76e3599
docs(v2): revise the introduction
2020-05-14 13:01:18 +08:00
be7367b2f8
feat(v2): allow prepending of baseUrl to href in navbar and footer ( #2746 )
2020-05-14 11:47:28 +08:00
afe70d973f
docs(v2): add new community plugin for dotenv support ( #2730 )
...
* Add new community plugin for dotenv support
Adds a link to a new community plugin that introduces support for environment variables managed in `.env` files.
* Update resources.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-05-10 21:01:27 +08:00
df815db031
docs(v2): fix correct route base path for docs-only mode
2020-05-02 23:58:56 +03:00
5761835ae8
docs(v2): replace word append with prepend to describe useBaseUrl hook ( #2707 )
...
* [doc] Replace word append with prepand to describe useBaseUrl hook
* [doc] Replace word append with prepend to describe useBaseUrl hook
* [doc] Replace append for all document versions
2020-05-02 03:05:51 +08:00
52b20826fd
docs(v2): add note about IE11
2020-04-30 11:06:19 +03:00
6190bf79a1
docs(v2): add note about IE11
2020-04-30 10:59:58 +03:00
d41f8ca1a9
docs(v2): various improvements
2020-04-28 17:44:06 +03:00
f8f6478c36
docs(v2): fix correct value for blog-only mode
2020-04-28 09:19:46 +03:00
7caf7de417
docs: add swizzle example ( #2680 )
2020-04-28 10:53:45 +08:00
c0e531e5d9
feat(v2): add ability to specify CSS class for navbar item ( #2660 )
...
* feat(v2): add ability to specify CSS class for navbar item
* Fix linting issues
2020-04-27 02:21:36 +08:00
af89a92628
feat(v2): add fallback to BrowserOnly component ( #2665 )
...
* feat(v2): add fallback to BrowserOnly component
* Update BrowserOnly.tsx
* Update docusaurus-core.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-26 20:39:34 +08:00
1471a6eb3a
docs(v2): add mention that appID is optional ( #2659 )
2020-04-25 19:00:01 +03:00
510bec6532
Revert "feat(v2): add option to toggle sidebar category open by default ( #2613 )" ( #2644 )
...
This reverts commit 1863a3c805
2020-04-22 18:50:18 +03:00
1863a3c805
feat(v2): add option to toggle sidebar category open by default ( #2613 )
...
* feat: update sidebar categ to take collapsed prop
* feat: add extra sidebars collapsed test
* fix: only mutate item.collapsed if necessary
* feat: update docs for SidebarItemCategory
* fix: update snapshots
* fix: update json to match new sidebar schema
* fix: update last snapshot
2020-04-22 20:31:10 +08:00
852b5e8f13
feat(v2): add CLI option for polling ( #2630 )
...
* Add CLI option to polling
Some environments (specifically docker containers) can have issues with file watching for live reloads. [Webpack Dev Server provides a polling alternative](https://webpack.js.org/configuration/watch/#watchoptionspoll ) option for this
* Update docusaurus.js
* Update cli.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-20 10:49:43 +08:00
14f4ef875a
feat(v2): add ability set dark mode by default ( #2597 )
...
* feat(v2): add ability set dark mode by default
* s/forceDarkMode/defaultDarkMode
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-17 19:19:55 +08:00
2f2e3cd99d
docs(v2): fix doc changes in #2606
2020-04-15 02:38:55 +08:00
a7b802f31a
docs(v2): improve grammar ( #2606 )
...
Signed-off-by: Reece Dunham <me@rdil.rocks>
2020-04-14 23:26:55 +08:00
ad425b2652
docs(v2): remove duplicated package.json in installation directory structure ( #2596 )
2020-04-13 17:33:40 +08:00
9c93d53a64
docs(v2): fix a grammatic issue ( #2592 )
2020-04-13 13:57:22 +08:00
109aa6c198
docs(v2): fix 1st custom admonition title example ( #2593 )
2020-04-13 03:36:58 +08:00
9c1abcddab
refactor(v2): use nav link component only where needed ( #2585 )
2020-04-12 13:34:50 +08:00
a8ab0d661e
docs(v2): mention that `plugin-ideal-image` only perform compression on a production build ( #2572 )
...
* Add a note that `plugin-ideal-image` only perform compression on a production build.
In reference to https://github.com/facebook/docusaurus/issues/2571
* Update using-plugins.md
* Update using-plugins.md
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-10 10:48:20 +08:00
dcf91ebfe4
docs(v2): fix syntax error for plugin config ( #2570 )
...
* Fix syntax error for plugin config
* Update using-plugins.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-10 10:43:02 +08:00
7092daf435
docs(v2): be more polite ( #2566 )
...
* docs(v2): be more polite
* Update deployment.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-09 15:28:58 +08:00
8d384b0d10
docs(v2): fix spelling of GitHub
2020-04-08 20:15:31 +03:00
92729af0ab
chore(v2): fix lint, tweak lqip-loader utils comment ( #2563 )
2020-04-09 01:08:58 +08:00
aeeb8531da
doc(v2): remove legacy blog metadata ( #2559 )
2020-04-08 22:17:17 +08:00
04a420d68f
refactor(v2): enhance CLI experience ( #2556 )
...
Signed-off-by: Reece Dunham <me@rdil.rocks>
2020-04-08 12:57:10 +08:00
71ac6d5712
doc(v2): update fanny profile
2020-04-07 09:34:13 -03:00
d9d7abf5c4
feat(v2): Add team photos
2020-04-07 09:21:02 -03:00
6a20183a68
docs(v2): command for swizzling all components ( #2549 )
...
* doc(v2): Add swizzle all components doc
* Update using-themes.md
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-06 02:52:46 +08:00
49a2958c96
docs(v2): fix name typoes in team page
2020-04-06 02:01:33 +08:00
1b227f6adb
docs(v2): fix typo in team page ( #2547 )
...
This is probably a copyover from https://reactjs.org/community/team.html
2020-04-06 01:34:31 +08:00
c1ef488115
docs(v2): add community pages ( #2545 )
...
* docs(v2): add community pages
* misc fixes
2020-04-06 01:10:22 +08:00
5e664a1f26
feat(v2): add edit url in post page ( #2524 )
...
* Add edit page url in docs
* feat(v2): Create EditPage component
* feat(v2): Improve component
* Add test
* çhore(v2): update description
* çhore(v2): update url
* fix(v2): test
* fix(v2): test
* feat(v2): change the prop of EditPage component
* chore(v2): Remove packages
* feat(v2): Update old tests
* chore(v2): fix package
* fix(v2): fix editUrl
* docs(v2): document editUrl
* --
* --
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-05 17:34:48 +08:00
95fdfe7e15
feat(v2): add blog post estimated reading time ( #2531 )
...
* feat: add estimated reading time to blog posts
* docs: add showReadingTime on plugin docs
* test: update plugin-content-blog tests to cover readingTime
* Update index.js
* Update using-plugins.md
* Update index.js
Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-04-05 15:08:42 +08:00
3dd83be988
docs(v2): proofread docs ( #2527 )
2020-04-04 14:05:59 +08:00
3052e4070b
docs(v2): useThemeContext hook ( #2521 )
2020-04-04 01:26:14 +08:00
2b4dbc322b
docs(v2): fix broken link to Sidebar item section
2020-04-03 11:15:28 +03:00
4956d1ec81
docs(v2): fix formatting
2020-04-02 12:07:50 +03:00
ehsan jso
Sébastien Lorber
Anshul Goyal
slorber
Colin Diesh
matbub
Marius Andra
Drew Alexander
Teik Jun
Sam Zhou
Yangshun Tay
Alexey Pyltsyn
Paul Glezen
hackerman
Koki Nishihara
Joe Previte
Muhammad Ali
Artem Kovalov
Fanny
Ben Gubler
Rajiv Singh
Jonny Nabors
Marco Moretti
Sylvain Pace
Tom Brien
Reece Dunham
Jay Lees
Kristóf Poduszló
Noah Silvera
Bartosz Kaszubowski
José Renan