Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: facebook/docusaurus
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v2.0.0-alpha.56
Choose a base ref
...
head repository: facebook/docusaurus
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v2.0.0-alpha.58
Choose a head ref
Loading
Showing with 8,022 additions and 2,305 deletions.
  1. +5 −0 .eslintignore
  2. +65 −3 .eslintrc.js
  3. +32 −0 .github/workflows/e2e-test.yml
  4. +2 −0 .gitignore
  5. +2 −0 .prettierignore
  6. +6 −0 .runme/Dockerfile.runme
  7. +10 −0 .runme/config.yaml
  8. +150 −0 CHANGELOG-2.x.md
  9. +2 −0 README.md
  10. +1 −1 lerna.json
  11. +23 −12 package.json
  12. +7 −0 packages/docusaurus-1.x/.eslintrc.js
  13. +1 −5 packages/docusaurus-1.x/lib/server/__tests__/utils.test.js
  14. +1 −1 packages/docusaurus-1.x/package.json
  15. +1 −1 packages/docusaurus-init-1.x/package.json
  16. +3 −2 packages/docusaurus-init/package.json
  17. +3 −0 packages/docusaurus-init/templates/bootstrap/babel.config.js
  18. +3 −3 packages/docusaurus-init/templates/bootstrap/package.json
  19. 0 packages/docusaurus-init/templates/bootstrap/static/.nojekyll
  20. +3 −0 packages/docusaurus-init/templates/classic/babel.config.js
  21. +4 −4 packages/docusaurus-init/templates/classic/package.json
  22. +4 −4 packages/docusaurus-init/templates/classic/src/pages/index.js
  23. 0 packages/docusaurus-init/templates/classic/static/.nojekyll
  24. +1 −0 packages/docusaurus-init/templates/facebook/.eslintrc.js
  25. +5 −8 ...-classic/src/theme/TabGroupChoiceContext.js → docusaurus-init/templates/facebook/babel.config.js}
  26. +7 −7 packages/docusaurus-init/templates/facebook/package.json
  27. +4 −4 packages/docusaurus-init/templates/facebook/src/pages/index.js
  28. 0 packages/docusaurus-init/templates/facebook/static/.nojekyll
  29. +1 −1 packages/docusaurus-mdx-loader/package.json
  30. +1 −1 packages/docusaurus-module-type-aliases/package.json
  31. +32 −0 packages/docusaurus-plugin-client-redirects/package.json
  32. +29 −0 ...ages/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/collectRedirects.test.ts.snap
  33. +29 −0 ...saurus-plugin-client-redirects/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap
  34. +37 −0 ...ocusaurus-plugin-client-redirects/src/__tests__/__snapshots__/normalizePluginOptions.test.ts.snap
  35. +11 −0 ...es/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/redirectValidation.test.ts.snap
  36. +71 −0 ...es/docusaurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap
  37. +255 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/collectRedirects.test.ts
  38. +26 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/createRedirectPageContent.test.ts
  39. +97 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/extensionRedirects.test.ts
  40. +72 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/normalizePluginOptions.test.ts
  41. +66 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/redirectValidation.test.ts
  42. +116 −0 packages/docusaurus-plugin-client-redirects/src/__tests__/writeRedirectFiles.test.ts
  43. +168 −0 packages/docusaurus-plugin-client-redirects/src/collectRedirects.ts
  44. +21 −0 packages/docusaurus-plugin-client-redirects/src/createRedirectPageContent.ts
  45. +90 −0 packages/docusaurus-plugin-client-redirects/src/extensionRedirects.ts
  46. +45 −0 packages/docusaurus-plugin-client-redirects/src/index.ts
  47. +72 −0 packages/docusaurus-plugin-client-redirects/src/normalizePluginOptions.ts
  48. +36 −0 packages/docusaurus-plugin-client-redirects/src/redirectValidation.ts
  49. +20 −0 packages/docusaurus-plugin-client-redirects/src/templates/redirectPage.template.html.ts
  50. +44 −0 packages/docusaurus-plugin-client-redirects/src/types.ts
  51. +84 −0 packages/docusaurus-plugin-client-redirects/src/writeRedirectFiles.ts
  52. +9 −0 packages/docusaurus-plugin-client-redirects/tsconfig.json
  53. +6 −5 packages/docusaurus-plugin-content-blog/package.json
  54. +2 −2 packages/docusaurus-plugin-content-blog/src/__tests__/linkify.test.ts
  55. +2 −3 packages/docusaurus-plugin-content-blog/src/blogUtils.ts
  56. +2 −2 packages/docusaurus-plugin-content-blog/src/index.ts
  57. +17 −5 packages/docusaurus-plugin-content-blog/src/markdownLoader.ts
  58. +6 −5 packages/docusaurus-plugin-content-docs/package.json
  59. 0 ...saurus-plugin-content-docs/src/__tests__/__fixtures__/{bad-site → bad-id-site}/docs/invalid-id.md
  60. +5 −0 ...urus-plugin-content-docs/src/__tests__/__fixtures__/bad-slug-on-doc-home-site/docs/docWithSlug.md
  61. +5 −0 ...ages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/bad-slug-site/docs/invalid-slug.md
  62. +20 −0 ...aurus-plugin-content-docs/src/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json
  63. +21 −0 packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/sidebars/sidebars-collapsed.json
  64. +1 −0 packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/simple-site/docs/foo/baz.md
  65. +3 −0 packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/versioned-site/docs/foo/bar.md
  66. +3 −0 ...in-content-docs/src/__tests__/__fixtures__/versioned-site/versioned_docs/version-1.0.0/foo/bar.md
  67. +71 −78 packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
  68. +81 −0 packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/sidebars.test.ts.snap
  69. +5 −0 packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/version.test.ts.snap
  70. +20 −17 packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
  71. +121 −14 packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts
  72. +16 −1 packages/docusaurus-plugin-content-docs/src/__tests__/sidebars.test.ts
  73. +63 −71 packages/docusaurus-plugin-content-docs/src/index.ts
  74. +6 −2 packages/docusaurus-plugin-content-docs/src/markdown/index.ts
  75. +68 −27 packages/docusaurus-plugin-content-docs/src/metadata.ts
  76. +27 −3 packages/docusaurus-plugin-content-docs/src/sidebars.ts
  77. +6 −3 packages/docusaurus-plugin-content-docs/src/types.ts
  78. +5 −4 packages/docusaurus-plugin-content-pages/package.json
  79. +25 −0 packages/docusaurus-plugin-debug/package.json
  80. +31 −0 packages/docusaurus-plugin-debug/src/index.ts
  81. +47 −0 packages/docusaurus-plugin-debug/src/theme/Debug/index.js
  82. +3 −8 ...p/src/theme/hooks/useThemeContext.js → docusaurus-plugin-debug/src/theme/Debug/styles.module.css}
  83. +9 −0 packages/docusaurus-plugin-debug/tsconfig.json
  84. +1 −1 packages/docusaurus-plugin-google-analytics/package.json
  85. +1 −1 packages/docusaurus-plugin-google-gtag/package.json
  86. +5 −4 packages/docusaurus-plugin-ideal-image/package.json
  87. +4 −3 packages/docusaurus-plugin-sitemap/package.json
  88. +2 −2 packages/docusaurus-plugin-sitemap/src/index.ts
  89. +5 −5 packages/docusaurus-preset-bootstrap/package.json
  90. +10 −9 packages/docusaurus-preset-classic/package.json
  91. +1 −0 packages/docusaurus-preset-classic/src/index.js
  92. +31 −0 packages/docusaurus-theme-bootstrap/README.md
  93. +1 −1 packages/docusaurus-theme-bootstrap/package.json
  94. +5 −0 packages/docusaurus-theme-bootstrap/src/theme/DocPage/index.js
  95. +1 −1 packages/docusaurus-theme-bootstrap/src/theme/DocPaginator/index.js
  96. +23 −2 packages/docusaurus-theme-bootstrap/src/theme/Navbar/index.js
  97. +1 −4 packages/docusaurus-theme-bootstrap/src/theme/hooks/useLogo.js
  98. +1 −1 packages/docusaurus-theme-classic/package-lock.json
  99. +3 −3 packages/docusaurus-theme-classic/package.json
  100. +2 −17 packages/docusaurus-theme-classic/src/prism-include-languages.js
  101. +2 −2 packages/docusaurus-theme-classic/src/theme/AnnouncementBar/index.js
  102. +0 −24 packages/docusaurus-theme-classic/src/theme/AnnouncementBarProvider/index.js
  103. +2 −2 packages/docusaurus-theme-classic/src/theme/BlogListPage/index.js
  104. +1 −1 packages/docusaurus-theme-classic/src/theme/BlogListPaginator/index.js
  105. +46 −33 packages/docusaurus-theme-classic/src/theme/BlogPostItem/index.js
  106. +1 −1 packages/docusaurus-theme-classic/src/theme/BlogPostPaginator/index.js
  107. +2 −2 packages/docusaurus-theme-classic/src/theme/BlogTagsListPage/index.js
  108. +2 −2 packages/docusaurus-theme-classic/src/theme/BlogTagsPostsPage/index.js
  109. +6 −23 packages/docusaurus-theme-classic/src/theme/CodeBlock/index.js
  110. +33 −11 packages/docusaurus-theme-classic/src/theme/DocItem/index.js
  111. +15 −29 packages/docusaurus-theme-classic/src/theme/DocPage/index.js
  112. +1 −1 packages/docusaurus-theme-classic/src/theme/DocPaginator/index.js
  113. +139 −102 packages/docusaurus-theme-classic/src/theme/DocSidebar/index.js
  114. +26 −18 packages/docusaurus-theme-classic/src/theme/DocSidebar/styles.module.css
  115. +3 −3 packages/docusaurus-theme-classic/src/theme/Footer/index.js
  116. +2 −2 packages/docusaurus-theme-classic/src/theme/Heading/index.js
  117. +2 −6 packages/docusaurus-theme-classic/src/theme/Heading/styles.module.css
  118. +35 −47 packages/docusaurus-theme-classic/src/theme/Layout/index.js
  119. +3 −0 packages/docusaurus-theme-classic/src/theme/MDXComponents/index.js
  120. +50 −20 packages/docusaurus-theme-classic/src/theme/Navbar/index.js
  121. +0 −24 packages/docusaurus-theme-classic/src/theme/TabGroupChoiceProvider/index.js
  122. +7 −6 packages/docusaurus-theme-classic/src/theme/Tabs/index.js
  123. +3 −3 packages/docusaurus-theme-classic/src/theme/Toggle/index.js
  124. +7 −2 packages/docusaurus-theme-classic/src/theme/{AnnouncementBarContext.js → UserPreferencesContext.js}
  125. +31 −0 packages/docusaurus-theme-classic/src/theme/UserPreferencesProvider/index.js
  126. +0 −16 packages/docusaurus-theme-classic/src/theme/hooks/useTabGroupChoiceContext.js
  127. +5 −4 ...aurus-theme-classic/src/theme/hooks/{useAnnouncementBarContext.js → useUserPreferencesContext.js}
  128. +48 −0 packages/docusaurus-theme-classic/src/theme/hooks/useWindowSize.js
  129. +27 −0 packages/docusaurus-theme-classic/src/theme/prism-include-languages.js
  130. +2 −3 packages/docusaurus-theme-live-codeblock/package.json
  131. +2 −1 packages/docusaurus-theme-live-codeblock/src/theme/CodeBlock/index.js
  132. +4 −4 packages/docusaurus-theme-live-codeblock/src/theme/Playground/index.js
  133. +4 −0 packages/docusaurus-theme-live-codeblock/src/theme/Playground/styles.module.css
  134. +6 −6 ...ap/src/theme/ThemeContext.js → docusaurus-theme-live-codeblock/src/theme/ReactLiveScope/index.js}
  135. +2 −2 packages/docusaurus-theme-search-algolia/package.json
  136. +6 −7 packages/docusaurus-theme-search-algolia/src/pages/search/index.js
  137. +3 −3 packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.js
  138. +4 −1 packages/docusaurus-theme-search-algolia/src/theme/hooks/useSearchQuery.js
  139. +1 −1 packages/docusaurus-types/package.json
  140. +3 −2 packages/docusaurus-utils/package.json
  141. +85 −1 packages/docusaurus-utils/src/__tests__/index.test.ts
  142. +65 −10 packages/docusaurus-utils/src/index.ts
  143. +7 −7 packages/docusaurus/package.json
  144. +81 −0 packages/docusaurus/src/babel/preset.ts
  145. +14 −0 packages/docusaurus/src/client/exports/__tests__/useBaseUrl.ts
  146. +13 −9 packages/docusaurus/src/client/exports/useBaseUrl.ts
  147. +3 −0 packages/docusaurus/src/client/types.d.ts
  148. +1 −0 packages/docusaurus/src/constants.ts
  149. +0 −2 packages/docusaurus/src/server/client-modules/__tests__/index.test.ts
  150. +3 −1 packages/docusaurus/src/server/config.ts
  151. +0 −2 packages/docusaurus/src/server/html-tags/__tests__/index.test.ts
  152. +3 −1 packages/docusaurus/src/server/plugins/init.ts
  153. +1 −1 packages/docusaurus/src/server/presets/__tests__/index.test.ts
  154. +15 −3 packages/docusaurus/src/webpack/base.ts
  155. +1 −1 packages/docusaurus/src/webpack/plugins/ChunkAssetPlugin.ts
  156. +21 −62 packages/docusaurus/src/webpack/utils.ts
  157. +1 −1 packages/lqip-loader/package.json
  158. +1 −1 packages/stylelint-copyright/package.json
  159. +2 −2 website-1.x/package.json
  160. +62 −51 website-1.x/pages/en/index.js
  161. +1 −1 website-1.x/static/css/custom.css
  162. +12 −0 website/babel.config.js
  163. +32 −0 website/docs/blog.md
  164. +18 −4 website/docs/configuration.md
  165. +23 −10 website/docs/deployment.md
  166. +34 −3 website/docs/docs.md
  167. +14 −1 website/docs/docusaurus-core.md
  168. +1 −1 website/docs/installation.md
  169. +105 −0 website/docs/markdown-features.mdx
  170. +137 −8 website/docs/migrating-from-v1-to-v2.md
  171. +1 −0 website/docs/resources.md
  172. +1 −0 website/docs/static-assets.md
  173. +16 −0 website/docs/theme-classic.md
  174. +121 −1 website/docs/using-plugins.md
  175. +21 −2 website/docusaurus.config.js
  176. +7 −6 website/package.json
  177. +45 −24 website/sidebars.js
  178. +3 −3 website/src/pages/feedback/index.js
  179. +18 −12 website/src/pages/index.js
  180. +4 −4 website/src/pages/showcase/index.js
  181. +2 −2 website/src/pages/versions.js
  182. +1 −1 website/src/plugins/remark-npm2yarn.js
  183. +15 −0 website/src/theme/ReactLiveScope/components.js
  184. +18 −0 website/src/theme/ReactLiveScope/index.js
  185. +0 −88 website/versioned_docs/version-2.0.0-alpha.43/cli.md
  186. +0 −148 website/versioned_docs/version-2.0.0-alpha.43/deployment.md
  187. +0 −244 website/versioned_docs/version-2.0.0-alpha.43/sidebar.md
  188. +0 −151 website/versioned_docs/version-2.0.0-alpha.43/theme-classic.md
  189. +1 −1 website/versioned_docs/version-2.0.0-alpha.48/docusaurus-core.md
  190. +1 −1 website/versioned_docs/version-2.0.0-alpha.48/using-plugins.md
  191. +1 −1 website/versioned_docs/version-2.0.0-alpha.50/docusaurus-core.md
  192. +1 −1 website/versioned_docs/version-2.0.0-alpha.50/using-plugins.md
  193. +1 −1 website/versioned_docs/version-2.0.0-alpha.54/docusaurus-core.md
  194. +1 −1 website/versioned_docs/version-2.0.0-alpha.54/using-plugins.md
  195. +1 −1 website/versioned_docs/version-2.0.0-alpha.55/docusaurus-core.md
  196. +1 −1 website/versioned_docs/version-2.0.0-alpha.55/using-plugins.md
  197. +28 −0 website/versioned_docs/version-2.0.0-alpha.56/blog.md
  198. +3 −3 website/versioned_docs/version-2.0.0-alpha.56/configuration.md
  199. +1 −1 website/versioned_docs/version-2.0.0-alpha.56/docusaurus-core.md
  200. +1 −1 website/versioned_docs/version-2.0.0-alpha.56/installation.md
  201. +1 −1 website/versioned_docs/version-2.0.0-alpha.56/presets.md
  202. +1 −1 website/versioned_docs/version-2.0.0-alpha.56/styling-layout.md
  203. +10 −10 website/versioned_docs/version-2.0.0-alpha.56/using-plugins.md
  204. +2 −2 website/versioned_docs/version-2.0.0-alpha.56/using-themes.md
  205. +56 −15 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/blog.md
  206. +113 −0 website/versioned_docs/version-2.0.0-alpha.57/cli.md
  207. +45 −25 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/configuration.md
  208. +5 −5 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/contributing.md
  209. +16 −2 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/creating-pages.md
  210. +312 −0 website/versioned_docs/version-2.0.0-alpha.57/deployment.md
  211. +5 −1 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/design-principles.md
  212. +363 −0 website/versioned_docs/version-2.0.0-alpha.57/docs.md
  213. +72 −23 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/docusaurus-core.md
  214. +32 −47 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/docusaurus.config.js.md
  215. +42 −5 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/installation.md
  216. +25 −24 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/introduction.md
  217. +38 −35 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/lifecycle-apis.md
  218. +496 −50 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/markdown-features.mdx
  219. +203 −75 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/migrating-from-v1-to-v2.md
  220. +23 −26 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/presets.md
  221. +45 −0 website/versioned_docs/version-2.0.0-alpha.57/resources.md
  222. +11 −7 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/search.md
  223. +15 −9 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/static-assets.md
  224. +82 −11 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/styling-layout.md
  225. +31 −0 website/versioned_docs/version-2.0.0-alpha.57/support.md
  226. +174 −0 website/versioned_docs/version-2.0.0-alpha.57/team.md
  227. +281 −0 website/versioned_docs/version-2.0.0-alpha.57/theme-classic.md
  228. +220 −59 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/using-plugins.md
  229. +30 −13 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/using-themes.md
  230. +12 −9 website/versioned_docs/{version-2.0.0-alpha.43 → version-2.0.0-alpha.57}/versioning.md
  231. +0 −132 website/versioned_sidebars/version-2.0.0-alpha.43-sidebars.json
  232. +162 −0 website/versioned_sidebars/version-2.0.0-alpha.57-sidebars.json
  233. +2 −2 website/versions.json
  234. +920 −59 yarn.lock
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -14,9 +14,14 @@ packages/docusaurus-1.x/lib/core/__tests__/split-tab.test.js
packages/docusaurus-utils/lib/
packages/docusaurus/lib/
packages/docusaurus-init/lib/
packages/docusaurus-plugin-client-redirects/lib/
packages/docusaurus-plugin-content-blog/lib/
packages/docusaurus-plugin-content-docs/lib/
packages/docusaurus-plugin-content-pages/lib/
packages/docusaurus-plugin-debug/lib/
packages/docusaurus-plugin-sitemap/lib/
packages/docusaurus-plugin-ideal-image/lib/
packages/docusaurus-plugin-ideal-image/copyUntypedFiles.js

packages/docusaurus-1.x/.eslintrc.js
packages/docusaurus-init/templates/facebook/.eslintrc.js
68 changes: 65 additions & 3 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -10,20 +10,35 @@ const WARNING = 1;
const ERROR = 2;

module.exports = {
root: true,
env: {
browser: true,
commonjs: true,
jest: true,
node: true,
},
parser: 'babel-eslint',
parser: '@typescript-eslint/parser',
parserOptions: {
allowImportExportEverywhere: true,
},
globals: {
testStylelintRule: true,
},
extends: ['airbnb', 'prettier', 'prettier/react'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/eslint-recommended',
'plugin:@typescript-eslint/recommended',
'airbnb',
'prettier',
'prettier/react',
],
settings: {
'import/resolver': {
node: {
extensions: ['.js', '.jsx', '.ts', '.tsx'],
},
},
},
plugins: ['react-hooks', 'header'],
rules: {
'class-methods-use-this': OFF, // It's a way of allowing private variables.
@@ -60,6 +75,53 @@ module.exports = {
'react/prefer-stateless-function': WARNING,
'react/jsx-props-no-spreading': OFF,
'react-hooks/rules-of-hooks': ERROR,
'@typescript-eslint/no-inferrable-types': OFF,
'import/first': OFF,
'import/order': OFF,
'lines-between-class-members': OFF,
'no-use-before-define': [
ERROR,
{functions: false, classes: false, variables: true},
],
'no-unused-vars': OFF,
'@typescript-eslint/no-unused-vars': [ERROR, {argsIgnorePattern: '^_'}],

// TODO re-enable some these as errors
// context: https://github.com/facebook/docusaurus/pull/2949
'@typescript-eslint/no-var-requires': WARNING,
'@typescript-eslint/ban-ts-comment': WARNING,
'@typescript-eslint/ban-types': WARNING,
'import/no-duplicates': WARNING,
'import/prefer-default-export': WARNING,
'import/no-extraneous-dependencies': WARNING,
'prefer-const': WARNING,
'no-useless-escape': WARNING,
'prefer-object-spread': WARNING,
'no-return-await': WARNING,
'prefer-template': WARNING,
'no-shadow': WARNING,
'no-param-reassign': WARNING,
'no-else-return': WARNING,
'no-template-curly-in-string': WARNING,
'array-callback-return': WARNING,
camelcase: WARNING,
'no-nested-ternary': WARNING,
'object-shorthand': WARNING,
'no-restricted-syntax': WARNING,
'no-unused-expressions': WARNING,
'consistent-return': WARNING,
'no-useless-return': WARNING,
'@typescript-eslint/no-empty-function': WARNING,
'global-require': WARNING,
'import/newline-after-import': WARNING,
'prefer-destructuring': WARNING,
yoda: WARNING,
'no-control-regex': WARNING,
'no-empty': WARNING,
'no-prototype-builtins': WARNING,
'no-case-declarations': WARNING,
'default-case': WARNING,
'dot-notation': WARNING,
},
overrides: [
{
@@ -68,7 +130,7 @@ module.exports = {
'packages/docusaurus-init/templates/classic/**/*.js',
],
rules: {
'header/header': 'off',
'header/header': OFF,
},
},
],
32 changes: 32 additions & 0 deletions .github/workflows/e2e-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: E2E Test

on:
# Trigger the workflow on push or pull request,
# but only for the master branch
push:
branches:
- master
pull_request:
branches:
- master

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [10.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Installation
run: yarn
- name: Setup test-website project against master release
run: yarn test:build:v2
- name: Build test-website project
run: cd test-website && yarn build
env:
CI: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -18,8 +18,10 @@ types
packages/docusaurus-utils/lib/
packages/docusaurus/lib/
packages/docusaurus-init/lib/
packages/docusaurus-plugin-client-redirects/lib/
packages/docusaurus-plugin-content-blog/lib/
packages/docusaurus-plugin-content-docs/lib/
packages/docusaurus-plugin-content-pages/lib/
packages/docusaurus-plugin-debug/lib/
packages/docusaurus-plugin-sitemap/lib/
packages/docusaurus-plugin-ideal-image/lib/
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -6,10 +6,12 @@ coverage
packages/docusaurus-utils/lib/
packages/docusaurus/lib/
packages/docusaurus-init/lib/
packages/docusaurus-plugin-client-redirects/lib/
packages/docusaurus-init/templates/**/*.md
packages/docusaurus-plugin-content-blog/lib/
packages/docusaurus-plugin-content-docs/lib/
packages/docusaurus-plugin-content-pages/lib/
packages/docusaurus-plugin-debug/lib/
packages/docusaurus-plugin-sitemap/lib/
packages/docusaurus-plugin-ideal-image/lib/
__fixtures__
6 changes: 6 additions & 0 deletions .runme/Dockerfile.runme
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FROM node:12.10.0
WORKDIR /app
RUN npx @docusaurus/init@next init website classic
RUN npm install http-server -g
RUN cd website && npm run build
ENTRYPOINT http-server ./website/build/ -p 80 -a 0.0.0.0
10 changes: 10 additions & 0 deletions .runme/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 1.0
publish: app
services:
app:
build:
type: dockerfile
config: ./.runme/Dockerfile.runme
ports:
- container: 80
public: 80
150 changes: 150 additions & 0 deletions CHANGELOG-2.x.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,159 @@
# Docusaurus 2 Changelog

## 2.0.0-alpha.58

#### :rocket: New Feature

- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`
- [#2916](https://github.com/facebook/docusaurus/pull/2916) feat(v2): add a banner that links to latest version of documentation ([@teikjun](https://github.com/teikjun))
- [#2682](https://github.com/facebook/docusaurus/pull/2682) feat(v2): expanded sidebar categories by default ([@jsjoeio](https://github.com/jsjoeio))
- `docusaurus-plugin-debug`, `docusaurus-preset-classic`
- [#2928](https://github.com/facebook/docusaurus/pull/2928) feat(v2): Implement proof-of-concept Docusaurus Debug Dashboard ([@SamChou19815](https://github.com/SamChou19815))
- `docusaurus-init`, `docusaurus`
- [#2903](https://github.com/facebook/docusaurus/pull/2903) feat(v2): Allow configuring babel via babel.config.js ([@SamChou19815](https://github.com/SamChou19815))
- `docusaurus-plugin-client-redirects`, `docusaurus-utils`
- [#2793](https://github.com/facebook/docusaurus/pull/2793) feat(v2): docusaurus-plugin-client-redirects ([@slorber](https://github.com/slorber))
- `docusaurus-theme-live-codeblock`
- [#2826](https://github.com/facebook/docusaurus/pull/2826) feat(v2): allow adding components to react-live scope ([@slorber](https://github.com/slorber))
- `docusaurus-theme-classic`, `docusaurus`
- [#2856](https://github.com/facebook/docusaurus/pull/2856) feat(v2): allow specifying meta image for blog posts ([@lex111](https://github.com/lex111))
- `docusaurus-theme-classic`
- [#2841](https://github.com/facebook/docusaurus/pull/2841) feat(v2): Allow swizzling prism-include-languages in theme-classic ([@SamChou19815](https://github.com/SamChou19815))

#### :boom: Breaking Change

- `docusaurus-init`, `docusaurus-theme-classic`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia`, `docusaurus`
- [#2895](https://github.com/facebook/docusaurus/pull/2895) chore(v2): replace classnames with clsx ([@lex111](https://github.com/lex111))
- `docusaurus-plugin-content-docs`
- [#2861](https://github.com/facebook/docusaurus/pull/2861) fix(v2): do not create route for document that serve as docs home page ([@lex111](https://github.com/lex111))
- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`
- [#2682](https://github.com/facebook/docusaurus/pull/2682) feat(v2): expanded sidebar categories by default ([@jsjoeio](https://github.com/jsjoeio))

#### :bug: Bug Fix

- `docusaurus-plugin-content-docs`, `docusaurus-theme-bootstrap`, `docusaurus-theme-classic`
- [#2905](https://github.com/facebook/docusaurus/pull/2905) fix(v2): fix docs homepage permalink issues ([@slorber](https://github.com/slorber))
- `docusaurus-theme-classic`
- [#2932](https://github.com/facebook/docusaurus/pull/2932) fix(v2): Add hooks to detect window resize, toggle off sidebar and navbar in desktop ([@guillaumejacquart](https://github.com/guillaumejacquart))
- [#2909](https://github.com/facebook/docusaurus/pull/2909) fix(v2): adjust anchor offset when routes switched ([@lex111](https://github.com/lex111))
- [#2896](https://github.com/facebook/docusaurus/pull/2896) fix(v2): set correct canonical url for docs home page ([@lex111](https://github.com/lex111))
- [#2893](https://github.com/facebook/docusaurus/pull/2893) fix(v2): Do not automatically change tab when a non-existing option is selected ([@SamChou19815](https://github.com/SamChou19815))
- [#2888](https://github.com/facebook/docusaurus/pull/2888) fix(v2): restore styles for menu scrollbar ([@lex111](https://github.com/lex111))
- [#2857](https://github.com/facebook/docusaurus/pull/2857) fix(v2): treat inline code in raw HTML as native element ([@lex111](https://github.com/lex111))
- `docusaurus`
- [#2951](https://github.com/facebook/docusaurus/pull/2951) fix(v2): Add optional-chaining and nullish-coalescing babel plugin ([@SamChou19815](https://github.com/SamChou19815))
- [#2921](https://github.com/facebook/docusaurus/pull/2921) fix(v2): upgrade react-loadable-ssr-addon ([@slorber](https://github.com/slorber))
- [#2854](https://github.com/facebook/docusaurus/pull/2854) fix(v2): fix broken build when swizzled NotFound component exist ([@lex111](https://github.com/lex111))
- [#2829](https://github.com/facebook/docusaurus/pull/2829) fix(v2): Fix plugin path resolution ([@SamChou19815](https://github.com/SamChou19815))
- `docusaurus-preset-classic`
- [#2944](https://github.com/facebook/docusaurus/pull/2944) fix(v2): Declare @docusaurus-plugin-debug as dependency of preset classic ([@SamChou19815](https://github.com/SamChou19815))
- `docusaurus-init`
- [#2902](https://github.com/facebook/docusaurus/pull/2902) feat(v2): add nojekyll file to static folder for all templates ([@teikjun](https://github.com/teikjun))
- `docusaurus-theme-bootstrap`
- [#2860](https://github.com/facebook/docusaurus/pull/2860) fix(v2): bootstrap doc sidebar ([@fanny](https://github.com/fanny))
- Other
- [#2874](https://github.com/facebook/docusaurus/pull/2874) fix(v2): Getting Started URL ([@fanny](https://github.com/fanny))
- `docusaurus-plugin-content-docs`
- [#2861](https://github.com/facebook/docusaurus/pull/2861) fix(v2): do not create route for document that serve as docs home page ([@lex111](https://github.com/lex111))
- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`
- [#2867](https://github.com/facebook/docusaurus/pull/2867) fix(v2): fix FOUC in doc sidebar and various improvements ([@slorber](https://github.com/slorber))
- `docusaurus-theme-search-algolia`
- [#2838](https://github.com/facebook/docusaurus/pull/2838) fix(v2): use base url to navigate to search page ([@tetunori](https://github.com/tetunori))
- `docusaurus-utils`
- [#2855](https://github.com/facebook/docusaurus/pull/2855) fix(v2): strip images and footnotes for excerpt correctly ([@lex111](https://github.com/lex111))
- `docusaurus-theme-live-codeblock`
- [#2835](https://github.com/facebook/docusaurus/pull/2835) fix(v2): set proper font for live editor ([@lex111](https://github.com/lex111))

#### :nail_care: Polish

- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`, `docusaurus-utils`, `docusaurus`
- [#2884](https://github.com/facebook/docusaurus/pull/2884) polish(v2): improve Docusaurus 1 to 2 migration developer experience ([@slorber](https://github.com/slorber))
- `docusaurus-theme-classic`
- [#2870](https://github.com/facebook/docusaurus/pull/2870) refactor(v2): combine nested theme providers into one ([@lex111](https://github.com/lex111))
- [#2880](https://github.com/facebook/docusaurus/pull/2880) fix(v2): render as regular text uncollapsible categories ([@lex111](https://github.com/lex111))
- [#2864](https://github.com/facebook/docusaurus/pull/2864) refactor(v2): add aria role for doc sidebar ([@lex111](https://github.com/lex111))
- [#2859](https://github.com/facebook/docusaurus/pull/2859) refactor(v2): add aria label to paginators ([@lex111](https://github.com/lex111))
- [#2858](https://github.com/facebook/docusaurus/pull/2858) refactor(v2): add missing main landmark for needed pages ([@lex111](https://github.com/lex111))
- Other
- [#2862](https://github.com/facebook/docusaurus/pull/2862) Updated banner in solidarity ([@JoelMarcey](https://github.com/JoelMarcey))

#### :memo: Documentation

- [#2946](https://github.com/facebook/docusaurus/pull/2946) docs(v2): add require.resolve to plugin imports on remaining pages ([@teikjun](https://github.com/teikjun))
- [#2941](https://github.com/facebook/docusaurus/pull/2941) docs(v2): wrap all plugin imports in require.resolve() ([@TomBrien](https://github.com/TomBrien))
- [#2934](https://github.com/facebook/docusaurus/pull/2934) docs(v2): add useThemeContext note ([@Drewbi](https://github.com/Drewbi))
- [#2935](https://github.com/facebook/docusaurus/pull/2935) docs(v2): Add router implementation note ([@Drewbi](https://github.com/Drewbi))
- [#2933](https://github.com/facebook/docusaurus/pull/2933) docs(v2): add documentation for multiple blogs ([@teikjun](https://github.com/teikjun))
- [#2910](https://github.com/facebook/docusaurus/pull/2910) docs(v2): fix GitHub action workflow in docs ([@anshulrgoyal](https://github.com/anshulrgoyal))
- [#2886](https://github.com/facebook/docusaurus/pull/2886) docs(v2): fix typo in command on installation page ([@pglezen](https://github.com/pglezen))
- [#2887](https://github.com/facebook/docusaurus/pull/2887) docs(v2): make .nojekyll warning more obvious ([@yangshun](https://github.com/yangshun))
- [#2865](https://github.com/facebook/docusaurus/pull/2865) docs(v2): description field in frontmatter of blog post ([@lex111](https://github.com/lex111))
- [#2839](https://github.com/facebook/docusaurus/pull/2839) docs(v2): \_index docs page does not show a sidebar ([@aeneasr](https://github.com/aeneasr))
- [#2852](https://github.com/facebook/docusaurus/pull/2852) misc: move runme demo in block quote about v2 ([@lex111](https://github.com/lex111))
- [#2842](https://github.com/facebook/docusaurus/pull/2842) docs(v2): Update ZEIT to Vercel ([@Nishikoh](https://github.com/Nishikoh))

#### :house: Internal

- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`
- [#2948](https://github.com/facebook/docusaurus/pull/2948) refactor(v2): legacy export = syntax ([@slorber](https://github.com/slorber))
- `docusaurus-init`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-plugin-ideal-image`, `docusaurus-plugin-sitemap`, `docusaurus-utils`, `docusaurus`
- [#2922](https://github.com/facebook/docusaurus/pull/2922) misc(v2): better dx: yarn clear, yarn watch, yarn serve ([@slorber](https://github.com/slorber))
- Other
- [#2929](https://github.com/facebook/docusaurus/pull/2929) chore(v2): Run E2E tests in CI ([@SamChou19815](https://github.com/SamChou19815))
- [#2899](https://github.com/facebook/docusaurus/pull/2899) chore(deps): bump websocket-extensions from 0.1.3 to 0.1.4 ([@dependabot[bot]](https://github.com/apps/dependabot))
- [#2897](https://github.com/facebook/docusaurus/pull/2897) refactor(v2): synchronize yarn/npm command on site ([@lex111](https://github.com/lex111))
- `docusaurus-theme-bootstrap`
- [#2931](https://github.com/facebook/docusaurus/pull/2931) chore(v2): remove unused hooks from bootstrap theme ([@fanny](https://github.com/fanny))
- `docusaurus-1.x`, `docusaurus-plugin-content-docs`
- [#2906](https://github.com/facebook/docusaurus/pull/2906) chore(v2): fix async tests ([@slorber](https://github.com/slorber))
- `docusaurus-theme-classic`
- [#2858](https://github.com/facebook/docusaurus/pull/2858) refactor(v2): add missing main landmark for needed pages ([@lex111](https://github.com/lex111))

#### :running_woman: Performance

- `docusaurus-plugin-content-blog`, `docusaurus-plugin-sitemap`
- [#2936](https://github.com/facebook/docusaurus/pull/2936) perf(v2): convert synchronous filewrite to asynchronous ([@moonrailgun](https://github.com/moonrailgun))
- `docusaurus-theme-classic`, `docusaurus-theme-live-codeblock`
- [#2900](https://github.com/facebook/docusaurus/pull/2900) chore(v2): replace Clipboard with copy-text-to-clipboard ([@lex111](https://github.com/lex111))
- `docusaurus-init`, `docusaurus-theme-classic`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia`, `docusaurus`
- [#2895](https://github.com/facebook/docusaurus/pull/2895) chore(v2): replace classnames with clsx ([@lex111](https://github.com/lex111))

#### Committers: 18

- Alexey Pyltsyn ([@lex111](https://github.com/lex111))
- Anshul Goyal ([@anshulrgoyal](https://github.com/anshulrgoyal))
- Drew Alexander ([@Drewbi](https://github.com/Drewbi))
- Fanny ([@fanny](https://github.com/fanny))
- Guillaume Jacquart ([@guillaumejacquart](https://github.com/guillaumejacquart))
- Joe Previte ([@jsjoeio](https://github.com/jsjoeio))
- Joel Marcey ([@JoelMarcey](https://github.com/JoelMarcey))
- Koki Nishihara ([@Nishikoh](https://github.com/Nishikoh))
- Paul Glezen ([@pglezen](https://github.com/pglezen))
- Sam Zhou ([@SamChou19815](https://github.com/SamChou19815))
- Sébastien Lorber ([@slorber](https://github.com/slorber))
- Teik Jun ([@teikjun](https://github.com/teikjun))
- Tom Brien ([@TomBrien](https://github.com/TomBrien))
- Yangshun Tay ([@yangshun](https://github.com/yangshun))
- [@belokonm](https://github.com/belokonm)
- hackerman ([@aeneasr](https://github.com/aeneasr))
- moonrailgun ([@moonrailgun](https://github.com/moonrailgun))
- tetunori ([@tetunori](https://github.com/tetunori))

## 2.0.0-alpha.57

Bad release, check ## 2.0.0-alpha.58

## 2.0.0-alpha.56

#### :boom: Breaking Change

- If you refer to modules (plugins) in your config file in a string form, you will need to replace them with `require.resolve` calls, for example:

```diff
- plugins: ['@docusaurus/plugin-google-analytics']
+ plugins: [require.resolve('@docusaurus/plugin-google-analytics')]
```

- `docusaurus-theme-classic`
- [#2818](https://github.com/facebook/docusaurus/pull/2818) feat(v2): automatically add base url to logo link ([@lex111](https://github.com/lex111))
- `docusaurus-theme-classic`, `docusaurus-theme-search-algolia`
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -17,6 +17,8 @@
</p>

> **We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the [Docusaurus v2 website](https://v2.docusaurus.io/) for more details.**
>
> You can see the clean live demo with classic theme by clicking this badge [![Runme](https://runme.io/static/button.svg)](https://runme.io/run?app_id=0dd80306-47bb-4e80-95dc-dc95eb05d3fd).
## Introduction

2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "2.0.0-alpha.56",
"version": "2.0.0-alpha.58",
"npmClient": "yarn",
"useWorkspaces": true,
"changelog": {
Loading