feat(v2): highlight items in the table of content

.eslintignore

@@ -16,3 +16,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

.gitignore

@@ -18,3 +18,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

.prettierignore

@@ -8,3 +8,4 @@ packages/docusaurus-init/lib/
 packages/docusaurus-plugin-content-blog/lib/
 packages/docusaurus-plugin-content-docs/lib/
 packages/docusaurus-plugin-content-pages/lib/
+packages/docusaurus-plugin-sitemap/lib/

CHANGELOG-2.x.md

@@ -2,17 +2,66 @@
 
 ## Unreleased
 
+- Add table of contents highlighting on scroll.
+
+## 2.0.0-alpha.32
+
+### Features
+
+- Add `<Redirect>` component for easy client side redirect. Example Usage:
+
+```js
+import React from 'react';
+import {Redirect} from '@docusaurus/router';
+
+function Home() {
+  return <Redirect to="/docs/test" />;
+}
+```
+
+- Allow user to add custom HTML to footer items. [#1905](https://github.com/facebook/docusaurus/pull/1905)
+- Added code block line highlighting feature (thanks @lex111)! If you have previously swizzled the `CodeBlock` theme component, it is recommended to update your source code to have this feature. ([#1860](https://github.com/facebook/Docusaurus/issues/1860))
+
+### Bug Fixes
+
+- Fix `@theme/Tabs` component to be able to create tabs with only one item.
+- Fix MDX `@theme/Heading` component. If there is no id, it should not create anchor link.
+- Fixed a bug in which if `themeConfig.algolia` is not defined, the custom searchbar won't appear. If you've swizzled Algolia `SearchBar` component before, please update your source code otherwise CSS might break. See [#1909](https://github.com/facebook/docusaurus/pull/1909/files) for reference.
+
+```js
+- <Fragment>
++ <div className="navbar__search" key="search-box">
+```
+
+- Slightly adjust search icon position to be more aligned on small width device. ([#1893](https://github.com/facebook/Docusaurus/issues/1893))
+- Fix algolia styling bug, previously search suggestion result is sometimes hidden. ([#1915](https://github.com/facebook/Docusaurus/issues/1915))
+- Changed the way we read the `USE_SSH` env variable during deployment to be the same as in v1.
+- Fix accessing `docs/` or `/docs/xxxx` that does not match any existing doc page should return 404 (Not found) page, not blank page. ([#1903](https://github.com/facebook/Docusaurus/issues/1903))
+- Prioritize `@docusaurus/core` dependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounter `Module not found: core-js/modules/xxxx` (because core-js@3 doesn't have that).
+- Fix a bug where docs plugin add `/docs` route even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. ([#1912](https://github.com/facebook/Docusaurus/issues/1912))
+
+### Performance Improvement
+
+- Reduce memory usage consumption. ([#1900](https://github.com/facebook/Docusaurus/issues/1900))
+- Significantly reduce main bundle size and initial HTML payload on production build. Generated files from webpack is also shorter in name. ([#1898](https://github.com/facebook/Docusaurus/issues/1898))
+- Simplify blog metadata. Previously, accessing `/blog/post-xxx` will request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. ([#1908](https://github.com/facebook/Docusaurus/issues/1908))
+
+### Others
+
+- Convert sitemap plugin to TypeScript. ([#1894](https://github.com/facebook/Docusaurus/issues/1894))
+- Refactor dark mode toggle into a hook. ([#1899](https://github.com/facebook/Docusaurus/issues/1899))
+
 ## 2.0.0-alpha.31
 
-- Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers. 
+- Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers.
 - Footer is now also displayed in docs page for consistency.
 - Remove empty doc sidebar container if sidebar for a particular doc page does not exist. Otherwise, it will cause an additional empty space.
-- Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard. 
+- Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard.
 - Fix search bar focus bug. When you put the focus on search input, previously the focus will remain although we have clicked to other area outside of the search input.
 - New themeConfig option `sidebarCollapsible`. It is on by default. If explicitly set to `false`, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar.
 - Disable adding hashes to the generated class names of CSS modules in dev mode. Generating unique identifiers takes some time, which can be saved since including paths to files in class names is enough to avoid collisions.
+- Fix showing sidebar category with empty items.
 - Update infima from 0.2.0-alpha.2 to 0.2.0-alpha.3
-  - Fix showing sidebar category with empty items.
   - Fix pagination nav and right sidebar color contrast ratio
   - Fix sidebar arrow color in dark mode
   - Fix footer mobile issue
@@ -23,11 +72,12 @@
 
 - Fix babel transpilation include/exclude logic to be more efficient. This also fix a very weird bug `TypeError: Cannot assign to read only property 'exports' of object '#<Object>'`.([#1868](https://github.com/facebook/docusaurus/pull/1868))
 
-If you are still encountering the error. Please check whether you use `module.exports` for your `.js` file instead of doing `export` (mixing CJS and ES). See https://github.com/webpack/webpack/issues/4039#issuecomment-477779322 and https://github.com/webpack/webpack/issues/4039#issuecomment-273804003 for more context. 
+If you are still encountering the error. Please check whether you use `module.exports` for your `.js` file instead of doing `export` (mixing CJS and ES). See https://github.com/webpack/webpack/issues/4039#issuecomment-477779322 and https://github.com/webpack/webpack/issues/4039#issuecomment-273804003 for more context.
 
 ## 2.0.0-alpha.29
 
-**HOTFIX for 2.0.0-alpha.28**. 
+**HOTFIX for 2.0.0-alpha.28**.
+
 - Fix missing `core-js` dependencies on `@docusaurus/core`.
 - Fix wrong `@babel/env` preset configuration that causes build compilation error.
 - New UI for webpack compilation progress bar.
@@ -42,7 +92,7 @@ If you are still encountering the error. Please check whether you use `module.ex
 - Fix logo URL in footer to be appended with baseUrl automatically.
 - Add the option `--no-open` for `start` command.
 - Set `@babel/env` useBuiltins to `usage`. This will automatically use browserlist and import polyfills required.
-- Modified TerserWebpackPlugin `terserOptions` for better cross-browser compatibility. 
+- Modified TerserWebpackPlugin `terserOptions` for better cross-browser compatibility.
 - **BREAKING** `withBaseUrl` is renamed to `useBaseUrl` because its a React Hooks. Make sure you import/rename it correctly. Eg: `import useBaseUrl from '@docusaurus/useBaseUrl`;
 - Fix potential security vulnerability because we're exposing the directory structure of the host machine.
 - Upgrade dependencies.
@@ -52,7 +102,7 @@ If you are still encountering the error. Please check whether you use `module.ex
 - Add `@theme/Tabs` which can be used to implement multi-language code tabs.
 - Implement `custom_edit_url` and `hide_title` markdown header for docusaurus v1 feature parity.
 - Reduce memory usage and slightly faster production build.
-- Misc dependency upgrades. 
+- Misc dependency upgrades.
 
 ## 2.0.0-alpha.26
 

CHANGELOG.md

@@ -14,7 +14,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 **Docs**
 
-- docs: document docker is optional ([#1848])(https://github.com/facebook/docusaurus/pull/1848)
+- docs: document docker is optional ([#1848](https://github.com/facebook/docusaurus/pull/1848))
 
 ## [1.13.0] - 2019-09-15
 
@@ -1178,7 +1178,8 @@ N/A
   - Blog
   - Documentation
 
-[unreleased]: https://github.com/facebook/docusaurus/compare/v1.13.0...HEAD
+[unreleased]: https://github.com/facebook/docusaurus/compare/v1.14.0...HEAD
+[1.14.0]: https://github.com/facebook/docusaurus/compare/v1.13.0...v1.14.0
 [1.13.0]: https://github.com/facebook/docusaurus/compare/v1.12.0...v1.13.0
 [1.12.0]: https://github.com/facebook/docusaurus/compare/v1.11.1...v1.12.0
 [1.11.1]: https://github.com/facebook/docusaurus/compare/v1.11.0...v1.11.1

README.md

@@ -19,15 +19,15 @@
 
 Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
 
-- **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.
-- **Localizable** Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation.html) via CrowdIn. Empower and grow your international community by translating your documentation.
-- **Customizable** While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/en/blog.html), and additional support pages, it is also [customizable](https://docusaurus.io/docs/en/custom-pages.html) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/en/api-pages.html).
+- **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation/) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.
+- **Localizable** Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation/) via CrowdIn. Empower and grow your international community by translating your documentation.
+- **Customizable** While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a [blog](https://docusaurus.io/docs/en/adding-blog/), and additional support pages, it is also [customizable](https://docusaurus.io/docs/en/custom-pages/) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/en/api-pages/).
 
 ## Installation
 
 Docusaurus is available as the [`docusaurus` package](https://www.npmjs.com/package/docusaurus) on [npm](https://www.npmjs.com).
 
-We have also released the [`docusaurus-init` package](https://www.npmjs.com/package/docusaurus-init) to make [getting started](https://docusaurus.io/docs/en/installation.html) with Docusaurus even easier.
+We have also released the [`docusaurus-init` package](https://www.npmjs.com/package/docusaurus-init) to make [getting started](https://docusaurus.io/docs/en/installation/) with Docusaurus even easier.
 
 ## Contributing
 

docs/getting-started-publishing.md

@@ -97,13 +97,19 @@ __Note:__ Not setting the `url` and `baseUrl` of your project might result in in
 
 To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.
 
+**Bash**
 ```bash
 GIT_USER=<GIT_USER> \
   CURRENT_BRANCH=master \
   USE_SSH=true \
   yarn run publish-gh-pages # or `npm run publish-gh-pages`
 ```
 
+**Windows**
+```batch
+cmd /C "set GIT_USER=<GIT_USER> && set CURRENT_BRANCH=master && set USE_SSH=true && yarn run publish-gh-pages"
+```
+
 There are also two optional parameters that are set as environment variables:
 
 | Name             | Description                                                                                                                                                                                                                                                       |

jest.config.js

@@ -7,20 +7,23 @@
 
 const path = require('path');
 
+const ignorePatterns = [
+  '/node_modules/',
+  '__fixtures__',
+  '/packages/docusaurus/lib',
+  '/packages/docusaurus-utils/lib',
+  '/packages/docusaurus-plugin-content-blog/lib',
+  '/packages/docusaurus-plugin-content-docs/lib',
+  '/packages/docusaurus-plugin-content-pages/lib',
+];
+
 module.exports = {
   rootDir: path.resolve(__dirname),
   verbose: true,
   testURL: 'http://localhost/',
   testEnvironment: 'node',
-  testPathIgnorePatterns: [
-    '/node_modules/',
-    '__fixtures__',
-    '/packages/docusaurus/lib',
-    '/packages/docusaurus-utils/lib',
-    '/packages/docusaurus-plugin-content-blog/lib',
-    '/packages/docusaurus-plugin-content-docs-legacy/lib',
-    '/packages/docusaurus-plugin-content-pages/lib',
-  ],
+  testPathIgnorePatterns: ignorePatterns,
+  coveragePathIgnorePatterns: ignorePatterns,
   transform: {
     '^.+\\.[jt]sx?$': 'babel-jest',
   },

lerna.json

@@ -1,6 +1,6 @@
 {
   "lerna": "3.14.1",
-  "version": "2.0.0-alpha.31",
+  "version": "2.0.0-alpha.32",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

packages/docusaurus-1.x/examples/basics/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:8.11.4
+FROM node:lts
 
 WORKDIR /app/website
 

packages/docusaurus-1.x/lib/core/renderMarkdown.js

@@ -7,7 +7,8 @@
 
 const _ = require('lodash');
 const hljs = require('highlight.js');
-const Markdown = require('remarkable');
+const {Remarkable: Markdown} = require('remarkable');
+const {linkify} = require('remarkable/linkify');
 const prismjs = require('prismjs');
 const loadLanguages = require('prismjs/components/index');
 const chalk = require('chalk');
@@ -83,7 +84,6 @@ class MarkdownRenderer {
         return '';
       },
       html: true,
-      linkify: true,
     };
 
     // Allow overriding default options
@@ -100,6 +100,9 @@ class MarkdownRenderer {
     // Register anchors plugin
     md.use(anchors);
 
+    // Linkify
+    md.use(linkify);
+
     // Allow client sites to register their own plugins
     if (siteConfig.markdownPlugins) {
       siteConfig.markdownPlugins.forEach(plugin => {

packages/docusaurus-1.x/lib/core/toc.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const Remarkable = require('remarkable');
+const {Remarkable} = require('remarkable');
 const mdToc = require('markdown-toc');
 const striptags = require('striptags');
 const toSlug = require('./toSlug');