Skip to content

Commit

Permalink
docs: v5 site upgrade (ant-design#38328)
Browse files Browse the repository at this point in the history
* build: try to use dumi as doc tool

* docs: migrate demo structure to dumi way

* refactor: use type export & import

* docs: migrate demo previewer to dumi

* docs: create empty layout & components

* docs: apply custom rehype plugin

* docs: create empty extra pages

* docs: Add Banner component

* chore: move theme tsconfig.json

* docs: home page init

* docs: migrate header (ant-design#37896)

* docs: header

* docs: update

* docs: home init

* clean up

* test: fix site lint

* chore: tsc ignore demo

* chore: dumi demo migrate script

* chore: cards

* docs: home layout

* docs: Update locale logic

* docs: fix getLink logic

* chore: fix ci (ant-design#37899)

* chore: fix ci

* ci: remove check-ts-demo

* ci: preview build

* test: ignore demo.tsx

* chore: update script

* test: update snapshot

* test: update node and image test

* chore: add .surgeignore

* docs: layout providers (ant-design#37908)

* docs: add components sidebar (ant-design#37923)

* docs: sidebar

* docs: update docs title

* docs: update design doc

* chore: code clean

* docs: handle changelog page

* docs: add title

* docs: add subtitle

* docs: active header nav

* chore: code clean

* docs: overview

* chore: code clean

* docs: update intl (ant-design#37918)

* docs: update intl

* chore: code clean

* docs: update favicons

* chore: update testPathIgnorePatterns

* chore: code clean

* chore: code clean

* chore: copy 404.html (ant-design#37996)

* docs: Home page theme picker

* chore: Update migrate script

* docs: home page update

* docs: theme editor style

* docs: theme lang

* chore: update migrate.js

* docs: fix demo (ant-design#38094)

* chore: update migrate.js

* docs: update md

* docs: update demo

* test: fix snapshot

* chore: move debug to code attr in migrate script

* chore: update md

Co-authored-by: PeachScript <[email protected]>

* feat: overview page

* feat: Migrate `404` page (ant-design#38118)

* feat: migrate IconSearch component (ant-design#37916)

* feat<site/IconSearch>: copy IconDisplay from site to .dumi

* feat<site/IconSearch>: change docs of icon

* feat<site/IconSearch>: tweak

* feat<site/IconSearch>: use useIntl instead of injectIntl

* feat<site/IconSearch>: fix ts type error

* feat<site/IconSearch>: use intl.formatMessage to render text

* docs: Adjust home btn sizw

* docs: Update doc

* feat: v5 site overview page (ant-design#38131)

* feat: site

* fix: fix

* feat: v5 site overview page

* fix: fix path

* fix: fix

* fix: fix

* docs: fix margin logic

* feat: v5 site change-log page (ant-design#38137)

* feat: v5 site change-log page (ant-design#38162)

* docs: site redirect to home pag

* docs: theme picker

* docs: use react-intl from dumi (ant-design#38183)

* docs: Theme Picker

* docs: update dumi config

* docs: home back fix

* docs: picker colorful

* docs: locale of it

* docs: update components desc

* docs: site of links

* docs: update components list

* docs: update desc

* feat: Migrate `DemoWrapper` component (ant-design#38166)

* feat: Migrate `DemoWrapper` component

* feat: remove invalid comments and add comment for `key` prop

* docs: FloatButton pure panel

* chore: update demo

* chore: update dumi config

* Revert "chore: update demo"

This reverts commit 028265d.

* chore: test logic adjust to support cnpm modules

* chore: add locale alias

* docs: /index to /

* docs: add locale redirect head script

* chore: adjust compact

* docs: fix missing token

* feat: compact switch

* chore: code clean

* docs: update home

* docs: fix radius token

* docs: hash of it

* chore: adjust home page

* docs: Add background map

* docs: site theme bac logic

* docs: avatar

* docs: update logo color

* docs: home banner

* docs: adjust tour size

* docs: purepanl update

* docs: transfooter

* docs: update banner gif

* docs: content (ant-design#38361)

* docs: title & EditButton

* docs: content

* chore: fix toc

* docs: resource page

* docs: transform resource data from hast

* docs: filename & Resource Card

* chore: enable prerender

* chore: remove less

* docs: toc style

* chore: fix lint

* docs: fix Layout page

* docs: fix CP page

* chore: update demos

* docs: workaround for export dynamic html

* chore: enable demo eslint

* docs: table style

* fix: header shadow

* chore: update snapshot

* fix: toc style

* docs: add title

* docs: Adjust site

* feat: helmet

* docs: site css

* fix: description

* feat: toc debug

* docs: update config-provider

* feat: use colorPanel

* fix: colorPanel value

* feat: anchor ink ball style

* feat: apply theme editor

* fix: code block style

* chore: update demo

* chore: fix lint

* chore: code clean

* chore: update snapshot

* feat: ts2js

* chore: description

* docs: site ready for ssr

includes:
- move client render logic to useEffect in site theme
- extract antd cssinjs to a single css file like bisheng
- workaround to support react@18 pipeableStream for emotion

* chore: bump testing lib

* docs: font size of title

* chore: remove react-sortable-hoc

* chore: update snapshot

* chore: update script

Co-authored-by: PeachScript <[email protected]>
Co-authored-by: MadCcc <[email protected]>
Co-authored-by: zqran <[email protected]>
Co-authored-by: TrickyPi <[email protected]>
Co-authored-by: lijianan <[email protected]>
  • Loading branch information
6 people authored Nov 9, 2022
1 parent 60d8e91 commit cbcfd38
Show file tree
Hide file tree
Showing 2,006 changed files with 45,327 additions and 58,435 deletions.
15 changes: 15 additions & 0 deletions .dumi/hooks/useLocale.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import * as React from 'react';
import { useLocale as useDumiLocale } from 'dumi';

export interface LocaleMap<Key extends string> {
cn: Record<Key, string>;
en: Record<Key, string>;
}

export default function useLocale<Key extends string>(
localeMap?: LocaleMap<Key>,
): [Record<Key, string>, 'cn' | 'en'] {
const { id } = useDumiLocale();
const localeType = id === 'zh-CN' ? 'cn' : ('en' as const);
return [localeMap?.[localeType]!, localeType];
}
47 changes: 47 additions & 0 deletions .dumi/hooks/useLocation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { useLocation as useDumiLocation } from 'dumi';
import * as React from 'react';
import useLocale from './useLocale';

function clearPath(path: string) {
return path.replace('-cn', '').replace(/\/$/, '');
}

export default function useLocation() {
const location = useDumiLocation();
const { search } = location;
const [, localeType] = useLocale();

const getLink = React.useCallback(
(path: string, hash?: string | { cn: string; en: string }) => {
let pathname = clearPath(path);

if (localeType === 'cn') {
pathname = `${pathname}-cn`;
}

if (search) {
pathname = `${pathname}${search}`;
}

if (hash) {
let hashStr: string;
if (typeof hash === 'object') {
hashStr = hash[localeType];
} else {
hashStr = hash;
}

pathname = `${pathname}#${hashStr}`;
}

return pathname;
},
[localeType, search],
);

return {
...location,
pathname: clearPath(location.pathname),
getLink,
};
}
138 changes: 138 additions & 0 deletions .dumi/hooks/useMenu.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
import React, { ReactNode, useMemo } from 'react';
import { MenuProps } from 'antd';
import { Link, useFullSidebarData, useSidebarData } from 'dumi';
import useLocation from './useLocation';

export type UseMenuOptions = {
before?: ReactNode;
after?: ReactNode;
};

const useMenu = (options: UseMenuOptions = {}): [MenuProps['items'], string] => {
const fullData = useFullSidebarData();
const { pathname } = useLocation();
const sidebarData = useSidebarData();
const { before, after } = options;

const menuItems = useMemo<MenuProps['items']>(() => {
const sidebarItems = [...(sidebarData ?? [])];

// 将设计文档未分类的放在最后
if (pathname.startsWith('/docs/spec')) {
const notGrouped = sidebarItems.splice(0, 1);
sidebarItems.push(...notGrouped);
}

// 把 /changelog 拼到开发文档中
if (pathname.startsWith('/docs/react')) {
const changelogData = Object.entries(fullData).find(([key]) =>
key.startsWith('/changelog'),
)?.[1];
if (changelogData) {
sidebarItems.push(...changelogData);
}
}
if (pathname.startsWith('/changelog')) {
const reactDocData = Object.entries(fullData).find(([key]) =>
key.startsWith('/docs/react'),
)?.[1];
if (reactDocData) {
sidebarItems.unshift(...reactDocData);
}
}

return (
sidebarItems?.reduce<Exclude<MenuProps['items'], undefined>>((result, group) => {
if (group.title) {
// 设计文档特殊处理二级分组
if (pathname.startsWith('/docs/spec')) {
const childrenGroup = group.children.reduce<
Record<string, ReturnType<typeof useSidebarData>[number]['children']>
>((childrenResult, child) => {
const type = (child.frontmatter as any).type ?? 'default';
if (!childrenResult[type]) {
childrenResult[type] = [];
}
childrenResult[type].push(child);
return childrenResult;
}, {});
const childItems = [];
childItems.push(
...childrenGroup.default.map(item => ({
label: (
<Link to={item.link}>
{before}
{item.title}
{after}
</Link>
),
key: item.link.replace(/(-cn$)/g, ''),
})),
);
Object.entries(childrenGroup).forEach(([type, children]) => {
if (type !== 'default') {
childItems.push({
type: 'group',
label: type,
key: type,
children: children?.map(item => ({
label: (
<Link to={item.link}>
{before}
{item.title}
{after}
</Link>
),
key: item.link.replace(/(-cn$)/g, ''),
})),
});
}
});
result.push({
label: group.title,
key: group.title,
children: childItems,
});
} else {
result.push({
type: 'group',
label: group.title,
key: group.title,
children: group.children?.map(item => ({
label: (
<Link to={item.link}>
{before}
<span key="english">{item.title}</span>
<span className="chinese" key="chinese">
{(item.frontmatter as any).subtitle}
</span>
{after}
</Link>
),
key: item.link.replace(/(-cn$)/g, ''),
})),
});
}
} else {
result.push(
...group.children?.map(item => ({
label: (
<Link to={item.link}>
{before}
{item.title}
{after}
</Link>
),
key: item.link.replace(/(-cn$)/g, ''),
})),
);
}
return result;
}, []) ?? []
);
}, [sidebarData, fullData, pathname]);

return [menuItems, pathname];
};

export default useMenu;
35 changes: 35 additions & 0 deletions .dumi/hooks/useSiteToken.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import { theme } from 'antd';
import { useContext } from 'react';
import { ConfigContext } from 'antd/es/config-provider';

const { useToken } = theme;

const useSiteToken = () => {
const result = useToken();
const { getPrefixCls, iconPrefixCls } = useContext(ConfigContext);
const rootPrefixCls = getPrefixCls();
const { token } = result;
const siteMarkdownCodeBg = token.colorFillTertiary;

return {
...result,
token: {
...token,
headerHeight: 64,
menuItemBorder: 2,
mobileMaxWidth: 767.99,
siteMarkdownCodeBg,
antCls: `.${rootPrefixCls}`,
iconCls: `.${iconPrefixCls}`,
/** 56 */
marginFarXS: (token.marginXXL / 6) * 7,
/** 80 */
marginFarSM: (token.marginXXL / 3) * 5,
/** 96 */
marginFar: token.marginXXL * 2,
codeFamily: `'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, Courier, monospace`,
},
};
};

export default useSiteToken;
30 changes: 7 additions & 23 deletions site/theme/template/NotFound.tsx → .dumi/pages/404/index.tsx
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
import React, { useEffect } from 'react';
import { Link } from 'bisheng/router';
import { Result, Button } from 'antd';
import { HomeOutlined } from '@ant-design/icons';
import * as utils from './utils';
import { Link, useLocation } from 'dumi';
import * as utils from '../../theme/utils';

export interface NotFoundProps {
location: {
pathname: string;
search: string;
hash: string;
state: any;
action: string;
key: any;
basename: string;
query: Record<string, string>;
};
router: {
push: (pathname: string) => void;
replace: (pathname: string) => void;
Expand All @@ -26,11 +16,8 @@ const DIRECT_MAP: Record<string, string> = {
'docs/spec/work-with-us': 'docs/resources',
};

export default function NotFound(props: NotFoundProps) {
const {
location: { pathname },
router,
} = props;
const NotFoundPage: React.FC<NotFoundProps> = ({ router }) => {
const { pathname } = useLocation();

const isZhCN = utils.isZhCN(pathname);

Expand Down Expand Up @@ -62,11 +49,8 @@ export default function NotFound(props: NotFoundProps) {
}
/>
</section>
<style
dangerouslySetInnerHTML={{
__html: '#react-content { height: 100%; background-color: #fff }',
}}
/>
</div>
);
}
};

export default NotFoundPage;
1 change: 1 addition & 0 deletions .dumi/pages/index-cn/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from '../index/index';
Loading

0 comments on commit cbcfd38

Please sign in to comment.