@docusaurus/theme-classic 2.0.0-beta.1ec2c95e3 → 2.0.0-beta.21

package/lib/theme/BlogPostItem/index.js

@@ -1,67 +1,50 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _react2 = require("@mdx-js/react");
-
-var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-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"));
-
-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; }
-
-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.
  */
+import React from 'react';
+import clsx from 'clsx';
+import Translate, {translate} from '@docusaurus/Translate';
+import Link from '@docusaurus/Link';
+import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
+import {usePluralForm} from '@docusaurus/theme-common';
+import {blogPostContainerID} from '@docusaurus/utils-common';
+import MDXContent from '@theme/MDXContent';
+import EditThisPage from '@theme/EditThisPage';
+import TagsListInline from '@theme/TagsListInline';
+import BlogPostAuthors from '@theme/BlogPostAuthors';
+import styles from './styles.module.css';
 // Very simple pluralization: probably good enough for now
 function useReadingTimePlural() {
-  const {
-    selectMessage
-  } = (0, _themeCommon.usePluralForm)();
-  return readingTimeFloat => {
+  const {selectMessage} = usePluralForm();
+  return (readingTimeFloat) => {
     const readingTime = Math.ceil(readingTimeFloat);
-    return selectMessage(readingTime, (0, _Translate.translate)({
-      id: 'theme.blog.post.readingTime.plurals',
-      description: 'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
-      message: 'One min read|{readingTime} min read'
-    }, {
-      readingTime
-    }));
+    return selectMessage(
+      readingTime,
+      translate(
+        {
+          id: 'theme.blog.post.readingTime.plurals',
+          description:
+            'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
+          message: 'One min read|{readingTime} min read',
+        },
+        {readingTime},
+      ),
+    );
   };
 }
-
-function BlogPostItem(props) {
+export default function BlogPostItem(props) {
   const readingTimePlural = useReadingTimePlural();
+  const {withBaseUrl} = useBaseUrlUtils();
   const {
     children,
     frontMatter,
+    assets,
     metadata,
     truncated,
-    isBlogPostPage = false
+    isBlogPostPage = false,
   } = props;
   const {
     date,
@@ -70,92 +53,102 @@ 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 renderPostHeader = () => {
-    const TitleHeading = isBlogPostPage ? 'h1' : 'h2';
-    return <header>
-        <TitleHeading className={_stylesModule.default.blogPostTitle}>
-          {isBlogPostPage ? title : <_Link.default to={permalink}>{title}</_Link.default>}
+  const image = assets.image ?? frontMatter.image;
+  const truncatedPost = !isBlogPostPage && truncated;
+  const tagsExists = tags.length > 0;
+  const TitleHeading = isBlogPostPage ? 'h1' : 'h2';
+  return (
+    <article
+      className={!isBlogPostPage ? 'margin-bottom--xl' : undefined}
+      itemProp="blogPost"
+      itemScope
+      itemType="http://schema.org/BlogPosting">
+      <header>
+        <TitleHeading className={styles.blogPostTitle} itemProp="headline">
+          {isBlogPostPage ? (
+            title
+          ) : (
+            <Link itemProp="url" to={permalink}>
+              {title}
+            </Link>
+          )}
         </TitleHeading>
-        <div className={(0, _clsx.default)(_stylesModule.default.blogPostData, 'margin-vert--md')}>
-          <time dateTime={date}>{formattedDate}</time>
+        <div className={clsx(styles.blogPostData, 'margin-vert--md')}>
+          <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>
-      </header>;
-  };
-
-  return <>
-      <_Seo.default {...{
-      keywords,
-      image
-    }} />
-
-      <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
-      })}>
-            {tags.length > 0 && <div className="col">
+        <BlogPostAuthors authors={authors} assets={assets} />
+      </header>
+
+      {image && (
+        <meta itemProp="image" content={withBaseUrl(image, {absolute: true})} />
+      )}
+
+      <div
+        // This ID is used for the feed generation to locate the main content
+        id={isBlogPostPage ? blogPostContainerID : undefined}
+        className="markdown"
+        itemProp="articleBody">
+        <MDXContent>{children}</MDXContent>
+      </div>
+
+      {(tagsExists || truncated) && (
+        <footer
+          className={clsx(
+            'row docusaurus-mt-lg',
+            isBlogPostPage && styles.blogPostDetailsFull,
+          )}>
+          {tagsExists && (
+            <div className={clsx('col', {'col--9': truncatedPost})}>
+              <TagsListInline tags={tags} />
+            </div>
+          )}
+
+          {isBlogPostPage && editUrl && (
+            <div className="col margin-top--sm">
+              <EditThisPage editUrl={editUrl} />
+            </div>
+          )}
+
+          {truncatedPost && (
+            <div
+              className={clsx('col text--right', {
+                'col--3': tagsExists,
+              })}>
+              <Link
+                to={metadata.permalink}
+                aria-label={translate(
+                  {
+                    message: 'Read more about {title}',
+                    id: 'theme.blog.post.readMoreLabel',
+                    description:
+                      'The ARIA label for the link to full blog posts from excerpts',
+                  },
+                  {title},
+                )}>
                 <b>
-                  <_Translate.default id="theme.tags.tagsListLabel" description="The label alongside a tag list">
-                    Tags:
-                  </_Translate.default>
+                  <Translate
+                    id="theme.blog.post.readMore"
+                    description="The label used in blog post item excerpts to link to full blog posts">
+                    Read More
+                  </Translate>
                 </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>
+            </div>
+          )}
+        </footer>
+      )}
+    </article>
+  );
 }
-
-var _default = BlogPostItem;
-exports.default = _default;

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

@@ -9,6 +9,15 @@
   font-size: 3rem;
 }
 
+/**
+  Blog post title should be smaller on smaller devices
+**/
+@media (max-width: 576px) {
+  .blogPostTitle {
+    font-size: 2rem;
+  }
+}
+
 .blogPostData {
   font-size: 0.9rem;
 }

package/lib/theme/BlogPostPage/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogPostPage';
+export default function BlogPostPage(props: Props): JSX.Element;

package/lib/theme/BlogPostPage/index.js

@@ -1,69 +1,99 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _BlogPostItem = _interopRequireDefault(require("@theme/BlogPostItem"));
-
-var _BlogPostPaginator = _interopRequireDefault(require("@theme/BlogPostPaginator"));
-
-var _BlogSidebar = _interopRequireDefault(require("@theme/BlogSidebar"));
-
-var _TOC = _interopRequireDefault(require("@theme/TOC"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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 BlogPostPage(props) {
-  const {
-    content: BlogPostContents,
-    sidebar
-  } = props;
-  const {
-    frontMatter,
-    metadata
-  } = BlogPostContents;
-  const {
-    title,
-    description,
-    nextItem,
-    prevItem
-  } = metadata;
+import React from 'react';
+import clsx from 'clsx';
+import {
+  PageMetadata,
+  HtmlClassNameProvider,
+  ThemeClassNames,
+} from '@docusaurus/theme-common';
+import BlogLayout from '@theme/BlogLayout';
+import BlogPostItem from '@theme/BlogPostItem';
+import BlogPostPaginator from '@theme/BlogPostPaginator';
+import TOC from '@theme/TOC';
+function BlogPostPageMetadata(props) {
+  const {content: BlogPostContents} = props;
+  const {assets, metadata} = BlogPostContents;
+  const {title, description, date, tags, authors, frontMatter} = metadata;
+  const {keywords} = frontMatter;
+  const image = assets.image ?? frontMatter.image;
+  return (
+    <PageMetadata
+      title={title}
+      description={description}
+      keywords={keywords}
+      image={image}>
+      <meta property="og:type" content="article" />
+      <meta property="article:published_time" content={date} />
+      {/* TODO double check those article meta array syntaxes, see https://ogp.me/#array */}
+      {authors.some((author) => author.url) && (
+        <meta
+          property="article:author"
+          content={authors
+            .map((author) => author.url)
+            .filter(Boolean)
+            .join(',')}
+        />
+      )}
+      {tags.length > 0 && (
+        <meta
+          property="article:tag"
+          content={tags.map((tag) => tag.label).join(',')}
+        />
+      )}
+    </PageMetadata>
+  );
+}
+function BlogPostPageContent(props) {
+  const {content: BlogPostContents, sidebar} = props;
+  const {assets, metadata} = BlogPostContents;
+  const {nextItem, prevItem, frontMatter} = metadata;
   const {
-    hide_table_of_contents: hideTableOfContents
+    hide_table_of_contents: hideTableOfContents,
+    toc_min_heading_level: tocMinHeadingLevel,
+    toc_max_heading_level: tocMaxHeadingLevel,
   } = frontMatter;
-  return <_Layout.default title={title} description={description} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.blogPages} pageClassName={_themeCommon.ThemeClassNames.page.blogPostPage}>
-      {BlogPostContents && <div className="container margin-vert--lg">
-          <div className="row">
-            <aside className="col col--3">
-              <_BlogSidebar.default sidebar={sidebar} />
-            </aside>
-            <main className="col col--7">
-              <_BlogPostItem.default frontMatter={frontMatter} metadata={metadata} isBlogPostPage>
-                <BlogPostContents />
-              </_BlogPostItem.default>
-              {(nextItem || prevItem) && <_BlogPostPaginator.default nextItem={nextItem} prevItem={prevItem} />}
-            </main>
-            {!hideTableOfContents && BlogPostContents.toc && <div className="col col--2">
-                <_TOC.default toc={BlogPostContents.toc} />
-              </div>}
-          </div>
-        </div>}
-    </_Layout.default>;
-}
+  return (
+    <BlogLayout
+      sidebar={sidebar}
+      toc={
+        !hideTableOfContents &&
+        BlogPostContents.toc &&
+        BlogPostContents.toc.length > 0 ? (
+          <TOC
+            toc={BlogPostContents.toc}
+            minHeadingLevel={tocMinHeadingLevel}
+            maxHeadingLevel={tocMaxHeadingLevel}
+          />
+        ) : undefined
+      }>
+      <BlogPostItem
+        frontMatter={frontMatter}
+        assets={assets}
+        metadata={metadata}
+        isBlogPostPage>
+        <BlogPostContents />
+      </BlogPostItem>
 
-var _default = BlogPostPage;
-exports.default = _default;
+      {(nextItem || prevItem) && (
+        <BlogPostPaginator nextItem={nextItem} prevItem={prevItem} />
+      )}
+    </BlogLayout>
+  );
+}
+export default function BlogPostPage(props) {
+  return (
+    <HtmlClassNameProvider
+      className={clsx(
+        ThemeClassNames.wrapper.blogPages,
+        ThemeClassNames.page.blogPostPage,
+      )}>
+      <BlogPostPageMetadata {...props} />
+      <BlogPostPageContent {...props} />
+    </HtmlClassNameProvider>
+  );
+}

package/lib/theme/BlogPostPaginator/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogPostPaginator';
+export default function BlogPostPaginator(props: Props): JSX.Element;

package/lib/theme/BlogPostPaginator/index.js

@@ -1,64 +1,47 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-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; }
-
-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 BlogPostPaginator(props) {
-  const {
-    nextItem,
-    prevItem
-  } = props;
-  return <nav className="pagination-nav docusaurus-mt-lg" aria-label={(0, _Translate.translate)({
-    id: 'theme.blog.post.paginator.navAriaLabel',
-    message: 'Blog post page navigation',
-    description: 'The ARIA label for the blog posts pagination'
-  })}>
-      <div className="pagination-nav__item">
-        {prevItem && <_Link.default className="pagination-nav__link" to={prevItem.permalink}>
-            <div className="pagination-nav__sublabel">
-              <_Translate.default id="theme.blog.post.paginator.newerPost" description="The blog post button label to navigate to the newer/previous post">
-                Newer Post
-              </_Translate.default>
-            </div>
-            <div className="pagination-nav__label">
-              &laquo; {prevItem.title}
-            </div>
-          </_Link.default>}
-      </div>
-      <div className="pagination-nav__item pagination-nav__item--next">
-        {nextItem && <_Link.default className="pagination-nav__link" to={nextItem.permalink}>
-            <div className="pagination-nav__sublabel">
-              <_Translate.default id="theme.blog.post.paginator.olderPost" description="The blog post button label to navigate to the older/next post">
-                Older Post
-              </_Translate.default>
-            </div>
-            <div className="pagination-nav__label">
-              {nextItem.title} &raquo;
-            </div>
-          </_Link.default>}
-      </div>
-    </nav>;
+import React from 'react';
+import Translate, {translate} from '@docusaurus/Translate';
+import PaginatorNavLink from '@theme/PaginatorNavLink';
+export default function BlogPostPaginator(props) {
+  const {nextItem, prevItem} = props;
+  return (
+    <nav
+      className="pagination-nav docusaurus-mt-lg"
+      aria-label={translate({
+        id: 'theme.blog.post.paginator.navAriaLabel',
+        message: 'Blog post page navigation',
+        description: 'The ARIA label for the blog posts pagination',
+      })}>
+      {prevItem && (
+        <PaginatorNavLink
+          {...prevItem}
+          subLabel={
+            <Translate
+              id="theme.blog.post.paginator.newerPost"
+              description="The blog post button label to navigate to the newer/previous post">
+              Newer Post
+            </Translate>
+          }
+        />
+      )}
+      {nextItem && (
+        <PaginatorNavLink
+          {...nextItem}
+          subLabel={
+            <Translate
+              id="theme.blog.post.paginator.olderPost"
+              description="The blog post button label to navigate to the older/next post">
+              Older Post
+            </Translate>
+          }
+          isNext
+        />
+      )}
+    </nav>
+  );
 }
-
-var _default = BlogPostPaginator;
-exports.default = _default;

package/lib/theme/BlogSidebar/Desktop/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogSidebar/Desktop';
+export default function BlogSidebarDesktop({ sidebar }: Props): JSX.Element;

package/{lib-next/theme/BlogSidebar → lib/theme/BlogSidebar/Desktop}/index.js

@@ -7,27 +7,23 @@
 import React from 'react';
 import clsx from 'clsx';
 import Link from '@docusaurus/Link';
-import styles from './styles.module.css';
 import {translate} from '@docusaurus/Translate';
-export default function BlogSidebar({sidebar}) {
-  if (sidebar.items.length === 0) {
-    return null;
-  }
-
+import styles from './styles.module.css';
+export default function BlogSidebarDesktop({sidebar}) {
   return (
-    <nav
-      className={clsx(styles.sidebar, 'thin-scrollbar')}
-      aria-label={translate({
-        id: 'theme.blog.sidebar.navAriaLabel',
-        message: 'Blog recent posts navigation',
-        description: 'The ARIA label for recent posts in the blog sidebar',
-      })}>
-      <div className={clsx(styles.sidebarItemTitle, 'margin-bottom--md')}>
-        {sidebar.title}
-      </div>
-      <ul className={styles.sidebarItemList}>
-        {sidebar.items.map((item) => {
-          return (
+    <aside className="col col--3">
+      <nav
+        className={clsx(styles.sidebar, 'thin-scrollbar')}
+        aria-label={translate({
+          id: 'theme.blog.sidebar.navAriaLabel',
+          message: 'Blog recent posts navigation',
+          description: 'The ARIA label for recent posts in the blog sidebar',
+        })}>
+        <div className={clsx(styles.sidebarItemTitle, 'margin-bottom--md')}>
+          {sidebar.title}
+        </div>
+        <ul className={clsx(styles.sidebarItemList, 'clean-list')}>
+          {sidebar.items.map((item) => (
             <li key={item.permalink} className={styles.sidebarItem}>
               <Link
                 isNavLink
@@ -37,9 +33,9 @@ export default function BlogSidebar({sidebar}) {
                 {item.title}
               </Link>
             </li>
-          );
-        })}
-      </ul>
-    </nav>
+          ))}
+        </ul>
+      </nav>
+    </aside>
   );
 }