admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve Documentation (#3795)

Browse Source 
* Begin docs improvement

* Keep improving documentation

* Upgrade Docusarus

* Fix broken links
This commit is contained in:
Félix Malfait
2024-02-05 15:01:37 +01:00
committed by GitHub
parent 6748dfebc4
commit a5989a470c
91 changed files with 1045 additions and 895 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
packages/twenty-docs/src/theme/DocCard/index.js
View File

@ -1,37 +1,39 @@
import React from 'react';
import clsx from 'clsx';
import isInternalUrl from '@docusaurus/isInternalUrl';
import Link from '@docusaurus/Link';
import {
findFirstCategoryLink,
useDocById,
} from '@docusaurus/theme-common/internal';
import isInternalUrl from '@docusaurus/isInternalUrl';
import {translate} from '@docusaurus/Translate';
import { translate } from '@docusaurus/Translate';
import clsx from 'clsx';
import * as icons from '../icons';
import styles from './styles.module.css';
import * as icons from "../icons";
function CardContainer({href, children}) {
function CardContainer({ href, children }) {
return (
<Link
href={href}
className={clsx('card padding--lg', styles.cardContainer)}>
className={clsx('card padding--lg', styles.cardContainer)}
>
{children}
</Link>
);
}
function CardLayout({href, icon, title, description}) {
function CardLayout({ href, icon, title, description }) {
return (
<CardContainer href={href}>
<h2 className={clsx("text--truncate", styles.cardTitle)} title={title}>
<h2 className={clsx('text--truncate', styles.cardTitle)} title={title}>
<span className={styles.icon}>
{typeof icon === "function" ? icon() : icon}
</span>{" "}
{typeof icon === 'function' ? icon() : icon}
</span>{' '}
{title}
</h2>
{description && (
<p
className={clsx("text--truncate", styles.cardDescription)}
className={clsx('text--truncate', styles.cardDescription)}
title={description}
>
{description}
@ -41,7 +43,7 @@ function CardLayout({href, icon, title, description}) {
);
}
function CardCategory({item}) {
function CardCategory({ item }) {
const href = findFirstCategoryLink(item);
// Unexpected: categories that don't have a link have been filtered upfront
if (!href) {
@ -61,17 +63,16 @@ function CardCategory({item}) {
description:
'The default description for a category card in the generated index about how many items this category includes',
},
{count: item.items.length},
{ count: item.items.length },
)
}
/>
);
}
function CardLink({ item }) {
const customIcon = item.customProps.icon;
const icon = icons[customIcon] || (isInternalUrl(item.href) ? "📄️" : "🔗");
const icon = icons[customIcon] || (isInternalUrl(item.href) ? '📄️' : '🔗');
const doc = useDocById(item.docId ?? undefined);
return (
@ -84,8 +85,7 @@ function CardLink({ item }) {
);
}
export default function DocCard({item}) {
export default function DocCard({ item }) {
switch (item.type) {
case 'link':
return <CardLink item={item} />;