@docusaurus/theme-classic 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

package/lib/theme/AnnouncementBar/styles.module.css

@@ -10,8 +10,8 @@
 }
 
 .announcementBar {
-  position: relative;
-  width: 100%;
+  display: flex;
+  align-items: center;
   height: var(--docusaurus-announcement-bar-height);
   background-color: var(--ifm-color-white);
   color: var(--ifm-color-black);
@@ -22,47 +22,27 @@ html[data-announcement-bar-initially-dismissed='true'] .announcementBar {
   display: none;
 }
 
-@media print {
-  .announcementBar {
-    display: none;
-  }
-}
-
-@media screen and (min-width: 1024px) {
-  :root {
-    --docusaurus-announcement-bar-height: 30px;
-  }
+.announcementBarPlaceholder {
+  flex: 0 0 10px;
 }
 
 .announcementBarClose {
-  position: absolute;
-  right: 0;
-  top: 0;
-  width: 55px;
-  font-size: 1.25rem;
-  height: 100%;
+  flex: 0 0 30px;
+  align-self: stretch;
+  padding: 0;
+  line-height: 0;
 }
 
 .announcementBarContent {
+  flex: 1 1 auto;
   font-size: 85%;
-  width: 100%;
   text-align: center;
   padding: 5px 0;
 }
 
-.announcementBarCloseable {
-  margin-right: 55px;
-}
-
-@media screen and (max-width: 576px) {
-  .announcementBarClose {
-    width: 35px;
-  }
-  .announcementBarContent {
-    width: auto;
-  }
-  .announcementBarCloseable {
-    margin-right: 35px;
+@media print {
+  .announcementBar {
+    display: none;
   }
 }
 
@@ -70,3 +50,14 @@ html[data-announcement-bar-initially-dismissed='true'] .announcementBar {
   color: inherit;
   text-decoration: underline;
 }
+
+@media (min-width: 997px) {
+  :root {
+    --docusaurus-announcement-bar-height: 30px;
+  }
+
+  .announcementBarPlaceholder,
+  .announcementBarClose {
+    flex-basis: 50px;
+  }
+}

package/lib/theme/BackToTopButton/index.js

@@ -9,10 +9,12 @@ var _react = _interopRequireWildcard(require("react"));
 
 var _clsx = _interopRequireDefault(require("clsx"));
 
-var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
+var _Translate = require("@docusaurus/Translate");
 
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
 
+var _themeCommon = require("@docusaurus/theme-common");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -76,21 +78,27 @@ function useSmoothScrollToTop() {
 }
 
 function BackToTopButton() {
+  const [show, setShow] = (0, _react.useState)(false);
+  const isFocusedAnchor = (0, _react.useRef)(false);
   const {
     smoothScrollTop,
     cancelScrollToTop
   } = useSmoothScrollToTop();
-  const [show, setShow] = (0, _react.useState)(false);
-  (0, _useScrollPosition.default)(({
+  (0, _themeCommon.useScrollPosition)(({
     scrollY: scrollTop
   }, lastPosition) => {
-    // No lastPosition means component is just being mounted.
+    const lastScrollTop = lastPosition === null || lastPosition === void 0 ? void 0 : lastPosition.scrollY; // No lastScrollTop means component is just being mounted.
     // Not really a scroll event from the user, so we ignore it
-    if (!lastPosition) {
+
+    if (!lastScrollTop) {
+      return;
+    }
+
+    if (isFocusedAnchor.current) {
+      isFocusedAnchor.current = false;
       return;
     }
 
-    const lastScrollTop = lastPosition.scrollY;
     const isScrollingUp = scrollTop < lastScrollTop;
 
     if (!isScrollingUp) {
@@ -112,14 +120,20 @@ function BackToTopButton() {
     } else {
       setShow(false);
     }
-  }, []);
-  return <button className={(0, _clsx.default)('clean-btn', _stylesModule.default.backToTopButton, {
+  });
+  (0, _themeCommon.useLocationChange)(locationChangeEvent => {
+    if (locationChangeEvent.location.hash) {
+      isFocusedAnchor.current = true;
+      setShow(false);
+    }
+  });
+  return <button aria-label={(0, _Translate.translate)({
+    id: 'theme.BackToTopButton.buttonAriaLabel',
+    message: 'Scroll back to top',
+    description: 'The ARIA label for the back to top button'
+  })} className={(0, _clsx.default)('clean-btn', _themeCommon.ThemeClassNames.common.backToTopButton, _stylesModule.default.backToTopButton, {
     [_stylesModule.default.backToTopButtonShow]: show
-  })} type="button" title="Scroll to top" onClick={() => smoothScrollTop()}>
-      <svg viewBox="0 0 24 24" width="28">
-        <path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor" />
-      </svg>
-    </button>;
+  })} type="button" onClick={() => smoothScrollTop()} />;
 }
 
 var _default = BackToTopButton;

package/lib/theme/BackToTopButton/styles.module.css

@@ -5,32 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-:root {
-  --docusaurus-btt-background: var(--ifm-color-primary);
-  --docusaurus-btt-color: #fff;
-}
-
 .backToTopButton {
-  display: flex;
-  align-items: center;
-  justify-content: center;
   position: fixed;
   right: 1.3rem;
   bottom: 1.3rem;
   border-radius: 50%;
-  background: var(--docusaurus-btt-background);
-  color: var(--docusaurus-btt-color);
+  background-color: var(--ifm-color-emphasis-200);
   width: 3rem;
   height: 3rem;
   z-index: var(--ifm-z-index-fixed);
-  box-shadow: 0 0.125rem 0.3125rem 0 rgba(0, 0, 0, 0.3);
-  transition: all var(--ifm-transition-fast) ease-in-out;
+  box-shadow: var(--ifm-global-shadow-lw);
+  transition: all var(--ifm-transition-fast)
+    var(--ifm-transition-timing-default);
   opacity: 0;
   transform: scale(0);
 }
 
-.backToTopButton:hover {
-  opacity: 0.8;
+.backToTopButton:after {
+  content: ' ';
+  display: inline-block;
+  mask: var(--ifm-menu-link-sublist-icon) 50% / 2rem 2rem no-repeat;
+  background-color: var(--ifm-color-emphasis-1000);
+  width: 100%;
+  height: 100%;
+}
+
+@media (hover: hover) {
+  .backToTopButton:hover {
+    background-color: var(--ifm-color-emphasis-300);
+  }
 }
 
 .backToTopButtonShow {

package/lib/theme/BlogArchivePage/index.js

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = BlogArchive;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Layout = _interopRequireDefault(require("@theme/Layout"));
+
+var _Link = _interopRequireDefault(require("@docusaurus/Link"));
+
+var _Translate = require("@docusaurus/Translate");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+function Year({
+  year,
+  posts
+}) {
+  return <>
+      <h3>{year}</h3>
+      <ul>
+        {posts.map(post => <li key={post.metadata.date}>
+            <_Link.default to={post.metadata.permalink}>
+              {post.metadata.formattedDate} - {post.metadata.title}
+            </_Link.default>
+          </li>)}
+      </ul>
+    </>;
+}
+
+function YearsSection({
+  years
+}) {
+  return <section className="margin-vert--lg">
+      <div className="container">
+        <div className="row">
+          {years.map((_props, idx) => <div key={idx} className="col col--4 margin-vert--lg">
+              <Year {..._props} />
+            </div>)}
+        </div>
+      </div>
+    </section>;
+}
+
+function listPostsByYears(blogPosts) {
+  const postsByYear = blogPosts.reduceRight((posts, post) => {
+    const year = post.metadata.date.split('-')[0];
+    const yearPosts = posts.get(year) || [];
+    return posts.set(year, [post, ...yearPosts]);
+  }, new Map());
+  return Array.from(postsByYear, ([year, posts]) => ({
+    year,
+    posts
+  }));
+}
+
+function BlogArchive({
+  archive
+}) {
+  const title = (0, _Translate.translate)({
+    id: 'theme.blog.archive.title',
+    message: 'Archive',
+    description: 'The page & hero title of the blog archive page'
+  });
+  const description = (0, _Translate.translate)({
+    id: 'theme.blog.archive.description',
+    message: 'Archive',
+    description: 'The page & hero description of the blog archive page'
+  });
+  const years = listPostsByYears(archive.blogPosts);
+  return <_Layout.default title={title} description={description}>
+      <header className="hero hero--primary">
+        <div className="container">
+          <h1 className="hero__title">{title}</h1>
+          <p className="hero__subtitle">{description}</p>
+        </div>
+      </header>
+      <main>{years.length > 0 && <YearsSection years={years} />}</main>
+    </_Layout.default>;
+}

package/lib/theme/BlogLayout/index.js

@@ -13,8 +13,6 @@ var _Layout = _interopRequireDefault(require("@theme/Layout"));
 
 var _BlogSidebar = _interopRequireDefault(require("@theme/BlogSidebar"));
 
-var _TOC = _interopRequireDefault(require("@theme/TOC"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -40,12 +38,10 @@ function BlogLayout(props) {
           <main className={(0, _clsx.default)('col', {
           'col--7': hasSidebar,
           'col--9 col--offset-1': !hasSidebar
-        })}>
+        })} itemScope itemType="http://schema.org/Blog">
             {children}
           </main>
-          {toc && <div className="col col--2">
-              <_TOC.default toc={toc} />
-            </div>}
+          {toc && <div className="col col--2">{toc}</div>}
         </div>
       </div>
     </_Layout.default>;

package/lib/theme/BlogListPage/index.js

@@ -49,7 +49,7 @@ function BlogListPage(props) {
   }} sidebar={sidebar}>
       {items.map(({
       content: BlogPostContent
-    }) => <_BlogPostItem.default key={BlogPostContent.metadata.permalink} frontMatter={BlogPostContent.frontMatter} metadata={BlogPostContent.metadata} truncated={BlogPostContent.metadata.truncated}>
+    }) => <_BlogPostItem.default key={BlogPostContent.metadata.permalink} frontMatter={BlogPostContent.frontMatter} assets={BlogPostContent.assets} metadata={BlogPostContent.metadata} truncated={BlogPostContent.metadata.truncated}>
           <BlogPostContent />
         </_BlogPostItem.default>)}
       <_BlogListPaginator.default metadata={metadata} />

package/lib/theme/BlogPostAuthor/index.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Link = _interopRequireDefault(require("@docusaurus/Link"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+function BlogPostAuthor({
+  author
+}) {
+  const {
+    name,
+    title,
+    url,
+    imageURL
+  } = author;
+  return <div className="avatar margin-bottom--sm">
+      {imageURL && <_Link.default className="avatar__photo-link avatar__photo" href={url}>
+          <img className={_stylesModule.default.image} src={imageURL} alt={name} />
+        </_Link.default>}
+
+      {// Note: only legacy author frontmatter allow empty name (not frontMatter.authors)
+    name && <div className="avatar__intro" itemProp="author" itemScope itemType="https://schema.org/Person">
+            <div className="avatar__name">
+              <_Link.default href={url} itemProp="url">
+                <span itemProp="name">{name}</span>
+              </_Link.default>
+            </div>
+            {title && <small className="avatar__subtitle" itemProp="description">
+                {title}
+              </small>}
+          </div>}
+    </div>;
+}
+
+var _default = BlogPostAuthor;
+exports.default = _default;

package/lib/theme/BlogPostAuthor/styles.module.css

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.image {
+  width: 100%;
+  height: 100%;
+  object-fit: cover;
+}

package/lib/theme/BlogPostAuthors/index.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = BlogPostAuthors;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _BlogPostAuthor = _interopRequireDefault(require("@theme/BlogPostAuthor"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+// Component responsible for the authors layout
+function BlogPostAuthors({
+  authors,
+  assets
+}) {
+  const authorsCount = authors.length;
+
+  if (authorsCount === 0) {
+    return <></>;
+  }
+
+  return <div className="row margin-top--md margin-bottom--sm">
+      {authors.map((author, idx) => {
+      var _assets$authorsImageU;
+
+      return <div className={(0, _clsx.default)('col col--6', _stylesModule.default.authorCol)} key={idx}>
+          <_BlogPostAuthor.default author={{ ...author,
+          // Handle author images using relative paths
+          imageURL: (_assets$authorsImageU = assets.authorsImageUrls[idx]) !== null && _assets$authorsImageU !== void 0 ? _assets$authorsImageU : author.imageURL
+        }} />
+        </div>;
+    })}
+    </div>;
+}

package/lib/theme/BlogPostAuthors/styles.module.css

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.authorCol {
+  max-width: inherit !important;
+  flex-grow: 1 !important;
+}

package/lib/theme/BlogPostItem/index.js

@@ -15,16 +15,20 @@ var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
 
 var _Link = _interopRequireDefault(require("@docusaurus/Link"));
 
+var _useBaseUrl = require("@docusaurus/useBaseUrl");
+
 var _themeCommon = require("@docusaurus/theme-common");
 
 var _MDXComponents = _interopRequireDefault(require("@theme/MDXComponents"));
 
-var _Seo = _interopRequireDefault(require("@theme/Seo"));
-
 var _EditThisPage = _interopRequireDefault(require("@theme/EditThisPage"));
 
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
 
+var _TagsListInline = _interopRequireDefault(require("@theme/TagsListInline"));
+
+var _BlogPostAuthors = _interopRequireDefault(require("@theme/BlogPostAuthors"));
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -55,10 +59,16 @@ function useReadingTimePlural() {
 }
 
 function BlogPostItem(props) {
+  var _assets$image;
+
   const readingTimePlural = useReadingTimePlural();
+  const {
+    withBaseUrl
+  } = (0, _useBaseUrl.useBaseUrlUtils)();
   const {
     children,
     frontMatter,
+    assets,
     metadata,
     truncated,
     isBlogPostPage = false
@@ -70,91 +80,72 @@ function BlogPostItem(props) {
     tags,
     readingTime,
     title,
-    editUrl
+    editUrl,
+    authors
   } = metadata;
-  const {
-    author,
-    image,
-    keywords
-  } = frontMatter;
-  const authorURL = frontMatter.author_url || frontMatter.authorURL;
-  const authorTitle = frontMatter.author_title || frontMatter.authorTitle;
-  const authorImageURL = frontMatter.author_image_url || frontMatter.authorImageURL;
+  const image = (_assets$image = assets.image) !== null && _assets$image !== void 0 ? _assets$image : frontMatter.image;
+  const truncatedPost = !isBlogPostPage && truncated;
+  const tagsExists = tags.length > 0;
 
   const renderPostHeader = () => {
     const TitleHeading = isBlogPostPage ? 'h1' : 'h2';
     return <header>
-        <TitleHeading className={_stylesModule.default.blogPostTitle}>
-          {isBlogPostPage ? title : <_Link.default to={permalink}>{title}</_Link.default>}
+        <TitleHeading className={_stylesModule.default.blogPostTitle} itemProp="headline">
+          {isBlogPostPage ? title : <_Link.default itemProp="url" to={permalink}>
+              {title}
+            </_Link.default>}
         </TitleHeading>
         <div className={(0, _clsx.default)(_stylesModule.default.blogPostData, 'margin-vert--md')}>
-          <time dateTime={date}>{formattedDate}</time>
+          <time dateTime={date} itemProp="datePublished">
+            {formattedDate}
+          </time>
 
-          {readingTime && <>
+          {typeof readingTime !== 'undefined' && <>
               {' · '}
               {readingTimePlural(readingTime)}
             </>}
         </div>
-        <div className="avatar margin-vert--md">
-          {authorImageURL && <_Link.default className="avatar__photo-link avatar__photo" href={authorURL}>
-              <img src={authorImageURL} alt={author} />
-            </_Link.default>}
-          <div className="avatar__intro">
-            {author && <>
-                <div className="avatar__name">
-                  <_Link.default href={authorURL}>{author}</_Link.default>
-                </div>
-                <small className="avatar__subtitle">{authorTitle}</small>
-              </>}
-          </div>
-        </div>
+        <_BlogPostAuthors.default authors={authors} assets={assets} />
       </header>;
   };
 
-  return <>
-      <_Seo.default {...{
-      keywords,
-      image
-    }} />
+  return <article className={!isBlogPostPage ? 'margin-bottom--xl' : undefined} itemProp="blogPost" itemScope itemType="http://schema.org/BlogPosting">
+      {renderPostHeader()}
 
-      <article className={!isBlogPostPage ? 'margin-bottom--xl' : undefined}>
-        {renderPostHeader()}
-        <div className="markdown">
-          <_react2.MDXProvider components={_MDXComponents.default}>{children}</_react2.MDXProvider>
-        </div>
-        {(tags.length > 0 || truncated) && <footer className={(0, _clsx.default)('row docusaurus-mt-lg', {
-        [_stylesModule.default.blogPostDetailsFull]: isBlogPostPage
+      {image && <meta itemProp="image" content={withBaseUrl(image, {
+      absolute: true
+    })} />}
+
+      <div className="markdown" itemProp="articleBody">
+        <_react2.MDXProvider components={_MDXComponents.default}>{children}</_react2.MDXProvider>
+      </div>
+
+      {(tagsExists || truncated) && <footer className={(0, _clsx.default)('row docusaurus-mt-lg', {
+      [_stylesModule.default.blogPostDetailsFull]: isBlogPostPage
+    })}>
+          {tagsExists && <div className={(0, _clsx.default)('col', {
+        'col--9': truncatedPost
+      })}>
+              <_TagsListInline.default tags={tags} />
+            </div>}
+
+          {isBlogPostPage && editUrl && <div className="col margin-top--sm">
+              <_EditThisPage.default editUrl={editUrl} />
+            </div>}
+
+          {truncatedPost && <div className={(0, _clsx.default)('col text--right', {
+        'col--3': tagsExists
       })}>
-            {tags.length > 0 && <div className="col">
+              <_Link.default to={metadata.permalink} aria-label={`Read more about ${title}`}>
                 <b>
-                  <_Translate.default id="theme.tags.tagsListLabel" description="The label alongside a tag list">
-                    Tags:
+                  <_Translate.default id="theme.blog.post.readMore" description="The label used in blog post item excerpts to link to full blog posts">
+                    Read More
                   </_Translate.default>
                 </b>
-                {tags.map(({
-            label,
-            permalink: tagPermalink
-          }) => <_Link.default key={tagPermalink} className="margin-horiz--sm" to={tagPermalink}>
-                    {label}
-                  </_Link.default>)}
-              </div>}
-
-            {isBlogPostPage && editUrl && <div className="col margin-top--sm">
-                <_EditThisPage.default editUrl={editUrl} />
-              </div>}
-
-            {!isBlogPostPage && truncated && <div className="col text--right">
-                <_Link.default to={metadata.permalink} aria-label={`Read more about ${title}`}>
-                  <b>
-                    <_Translate.default id="theme.blog.post.readMore" description="The label used in blog post item excerpts to link to full blog posts">
-                      Read More
-                    </_Translate.default>
-                  </b>
-                </_Link.default>
-              </div>}
-          </footer>}
-      </article>
-    </>;
+              </_Link.default>
+            </div>}
+        </footer>}
+    </article>;
 }
 
 var _default = BlogPostItem;