mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 08:49:51 +02:00
9473508c33
* add theme-common/internal export * Split @docusaurus/theme-common into public/internal apis * fixes * public <-> private * public <-> private * public <-> private * fix * add "removeThemeInternalReexport" CI script * :s windows CI check not working: not that useful * remove bad import * refactors * reorder * make useBackToTopButton internal Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
48 lines
1.5 KiB
TypeScript
48 lines
1.5 KiB
TypeScript
/**
|
|
* 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 {ThemeClassNames} from '@docusaurus/theme-common';
|
|
import {useDoc} from '@docusaurus/theme-common/internal';
|
|
import Heading from '@theme/Heading';
|
|
import MDXContent from '@theme/MDXContent';
|
|
import type {Props} from '@theme/DocItem/Content';
|
|
|
|
/**
|
|
Title can be declared inside md content or declared through
|
|
front matter and added manually. To make both cases consistent,
|
|
the added title is added under the same div.markdown block
|
|
See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
|
|
|
|
We render a "synthetic title" if:
|
|
- user doesn't ask to hide it with front matter
|
|
- the markdown content does not already contain a top-level h1 heading
|
|
*/
|
|
function useSyntheticTitle(): string | null {
|
|
const {metadata, frontMatter, contentTitle} = useDoc();
|
|
const shouldRender =
|
|
!frontMatter.hide_title && typeof contentTitle === 'undefined';
|
|
if (!shouldRender) {
|
|
return null;
|
|
}
|
|
return metadata.title;
|
|
}
|
|
|
|
export default function DocItemContent({children}: Props): JSX.Element {
|
|
const syntheticTitle = useSyntheticTitle();
|
|
return (
|
|
<div className={clsx(ThemeClassNames.docs.docMarkdown, 'markdown')}>
|
|
{syntheticTitle && (
|
|
<header>
|
|
<Heading as="h1">{syntheticTitle}</Heading>
|
|
</header>
|
|
)}
|
|
<MDXContent>{children}</MDXContent>
|
|
</div>
|
|
);
|
|
}
|