Generated docs cleanup (#3935)

Our generated docs are pretty verbose and space inefficient. This diff
has a few design tweaks to try and make sure that the information that's
emphasised is the stuff that's most important, and makes the typical
docs item use a bit less space in the process.


![image](https://github.com/tldraw/tldraw/assets/1489520/df433ae0-1400-4f5b-951e-e25869621a40)



### Change Type

- [x] `docs` — Changes to the documentation, examples, or templates.
- [x] `improvement` — Improving existing features
This commit is contained in:
alex 2024-06-13 17:04:12 +01:00 committed by GitHub
parent 012e54959d
commit fba82ed924
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 219 additions and 82 deletions

View file

@ -5,6 +5,7 @@ import { Breadcrumb } from './Breadcrumb'
import { Header } from './Header'
import { Mdx } from './Mdx'
import { Sidebar } from './Sidebar'
import { TitleWithSourceLink } from './mdx-components/api-docs'
import { Image } from './mdx-components/generic'
export async function ArticleReferenceDocsPage({ article }: { article: Article }) {
@ -25,7 +26,9 @@ export async function ArticleReferenceDocsPage({ article }: { article: Article }
<main className="main-content article article__api-docs">
<div className="page-header">
<Breadcrumb section={section} category={category} />
<h1>{article.title}</h1>
<TitleWithSourceLink source={article.sourceUrl} large tags={article.apiTags?.split(',')}>
<h1>{article.title}</h1>
</TitleWithSourceLink>
</div>
{article.hero && <Image alt="hero" title={article.title} src={`images/${article.hero}`} />}
{article.content && <Mdx content={article.content} />}