Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

feat(docs-contributors): 文档添加贡献者信息 #314

Merged
merged 2 commits into from
Mar 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions @antv/gatsby-theme-antv/gatsby-node.js
Original file line number Diff line number Diff line change
Expand Up @@ -423,10 +423,16 @@ exports.sourceNodes = ({ actions }) => {
const { createTypes } = actions;

createTypes(`
type Contributor {
author: String
avatar: String
github: String
}
type MarkdownRemarkFrontmatter {
icon: String
order: Int
redirect_from: [String]
contributors: [Contributor]
}

type MarkdownRemark {
Expand Down
1 change: 1 addition & 0 deletions @antv/gatsby-theme-antv/site/common.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"周边生态": "Ecosystem",
"搜索…": "Search...",
"在 GitHub 上编辑": "Edit on GitHub",
"贡献者": "Contributors",
"演示": "Examples",
"代码演示": "Examples",
"设计指引": "Design Guide",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.docs-contributors {
display: inline-block;

img {
cursor: pointer;
}
}
37 changes: 37 additions & 0 deletions @antv/gatsby-theme-antv/site/components/Contributors.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import React from 'react';
import _ from 'lodash';
import { Avatar, Tooltip } from 'antd';
import styles from './Contributors.module.less';

type Props = {
contributors: Array<{
author?: string;
avatar: string;
github: string;
}>;
style?: React.CSSProperties;
};

const Contributors: React.FC<Props> = (props) => {
const { contributors, style } = props;

const openGithub = (githubId: string) => {
window.open(`https://github.com/${githubId}`);
};

return (
<div className={styles.docsContributors} style={style || {}}>
{_.map(contributors, ({ author, avatar, github }) => {
return (
<Tooltip title={author}>
<span onClick={() => openGithub(github)}>
<Avatar size={24} src={avatar} />
</span>
</Tooltip>
);
})}
</div>
);
};

export default Contributors;
8 changes: 8 additions & 0 deletions @antv/gatsby-theme-antv/site/templates/document.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import NavigatorBanner from '../components/NavigatorBanner';
import SEO from '../components/Seo';
import CustomTag from '../components/CustomTag';
import MdPlayground from '../components/MdPlayground';
import Contributors from '../components/Contributors';
import { usePrevAndNext } from '../hooks';
import { capitalize } from '../utils';
import styles from './markdown.module.less';
Expand Down Expand Up @@ -435,6 +436,8 @@ export default function Template({
</h1>
<div className={styles.meta}>
<ReadingTime readingTime={readingTime} />
<span className={styles.contributorsLabel}>{t('贡献者')}:</span>
<Contributors contributors={frontmatter.contributors} />
</div>
<div className={styles.content}>{renderAst(htmlAst)}</div>
<div>
Expand Down Expand Up @@ -482,6 +485,11 @@ export const pageQuery = graphql`
}
frontmatter {
title
contributors {
author
github
avatar
}
}
parent {
... on File {
Expand Down
4 changes: 4 additions & 0 deletions @antv/gatsby-theme-antv/site/templates/markdown.module.less
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@
.contentReset;
}
}

.contributors-label {
margin: 0 8px;
}
}

// reference yuque UI
Expand Down
8 changes: 8 additions & 0 deletions example/docs/api/g2plot/scatter.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
---
title: Scatter
order: 1
contributors:
[
{
author: '新茗',
github: 'visiky',
avatar: 'https://gw.alipayobjects.com/zos/antfincdn/KAeYPA3TV0/avatar.jpeg',
},
]
---

### 图表容器
Expand Down
8 changes: 8 additions & 0 deletions example/docs/api/g2plot/scatter.zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
---
title: 散点图
order: 1
contributors:
[
{
author: '新茗',
github: 'visiky',
avatar: 'https://gw.alipayobjects.com/zos/antfincdn/KAeYPA3TV0/avatar.jpeg',
},
]
---

### 图表容器
Expand Down