mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-31 23:40:39 +02:00
docs: add link from every category index page to the guide page (#7665)
This commit is contained in:
parent
42ab07f62f
commit
8e3e89d9ff
4 changed files with 120 additions and 43 deletions
44
website/src/theme/DocCategoryGeneratedIndexPage/index.tsx
Normal file
44
website/src/theme/DocCategoryGeneratedIndexPage/index.tsx
Normal file
|
@ -0,0 +1,44 @@
|
|||
/**
|
||||
* 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 {useLayoutDoc} from '@docusaurus/theme-common';
|
||||
import Link from '@docusaurus/Link';
|
||||
import Translate from '@docusaurus/Translate';
|
||||
import DocCategoryGeneratedIndexPage from '@theme-original/DocCategoryGeneratedIndexPage';
|
||||
import type {Props} from '@theme/DocCategoryGeneratedIndexPage';
|
||||
|
||||
import styles from './styles.module.css';
|
||||
|
||||
function HintFooter() {
|
||||
const docPath = useLayoutDoc('guides/docs/sidebar/items', undefined)?.path;
|
||||
return (
|
||||
<p className={styles.footerTip}>
|
||||
<Translate
|
||||
values={{
|
||||
guideLink: (
|
||||
<Link to={`${docPath}#category-link`}>
|
||||
<Translate>the generated index page guide</Translate>
|
||||
</Link>
|
||||
),
|
||||
}}>
|
||||
{'Want to implement the same page? Read {guideLink} to find out!'}
|
||||
</Translate>
|
||||
</p>
|
||||
);
|
||||
}
|
||||
|
||||
export default function DocCategoryGeneratedIndexPageWrapper(
|
||||
props: Props,
|
||||
): JSX.Element {
|
||||
return (
|
||||
<>
|
||||
<DocCategoryGeneratedIndexPage {...props} />
|
||||
<HintFooter />
|
||||
</>
|
||||
);
|
||||
}
|
|
@ -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.
|
||||
*/
|
||||
|
||||
.footerTip {
|
||||
font-size: 0.8rem;
|
||||
margin-top: var(--ifm-paragraph-margin-bottom);
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue