3ae48af67c
This PR starts putting in place the high-level changes we want to make to the docs site. - It makes separate sections for Reference and Examples and Community. - Gets rid of the secondary sidebar and integrates it into the main sidebar. - Groups the reference articles by type. - Pulls in the examples alongside code and a live playground so people don't have to visit examples.tldraw.com separately. <img width="1458" alt="Screenshot 2024-01-30 at 09 43 46" src="https://github.com/tldraw/tldraw/assets/469604/4f5aa339-3a69-4d9b-9b9f-dfdddea623e8"> Again, this is the top-level changes and there's more to be done for the next PR(s): - create quick start page - clean up installation page - add accordion to Examples page prbly - put fun stuff in header (from footer) - landing page - something for landing page of API - search cmd-k and border - cleanup _sidebarReferenceContentLinks - external links _blank - address potential skew issue with code examples - have a link to other examples (next.js, etc.) ### Change Type - [x] `documentation` — Changes to the documentation only[^2] ### Test Plan 1. Make sure examples work! ### Release Notes - Rework our docs site to pull together the examples app and reference section more cohesively. --------- Co-authored-by: Taha <98838967+Taha-Hassan-Git@users.noreply.github.com> Co-authored-by: Steve Ruiz <steveruizok@gmail.com> Co-authored-by: Mitja Bezenšek <mitja.bezensek@gmail.com> Co-authored-by: alex <alex@dytry.ch> Co-authored-by: Lu Wilson <l2wilson94@gmail.com> Co-authored-by: Dan Groshev <git@dgroshev.com>
138 lines
3.2 KiB
TypeScript
138 lines
3.2 KiB
TypeScript
import { Article, ArticleHeadings, GeneratedContent } from '@/types/content-types'
|
|
import GithubSlugger from 'github-slugger'
|
|
import { Database } from 'sqlite'
|
|
import sqlite3 from 'sqlite3'
|
|
|
|
export async function addContentToDb(
|
|
db: Database<sqlite3.Database, sqlite3.Statement>,
|
|
content: GeneratedContent
|
|
) {
|
|
const sectionInsert = await db.prepare(
|
|
`REPLACE INTO sections (id, idx, title, description, path, sidebar_behavior) VALUES (?, ?, ?, ?, ?, ?)`
|
|
)
|
|
|
|
const categoryInsert = await db.prepare(
|
|
`REPLACE INTO categories (id, title, description, sectionId, sectionIndex, path) VALUES (?, ?, ?, ?, ?, ?)`
|
|
)
|
|
|
|
const headingsInsert = await db.prepare(
|
|
`REPLACE INTO headings (idx, articleId, level, title, slug, isCode, path) VALUES (?, ?, ?, ?, ?, ?, ?)`
|
|
)
|
|
|
|
const articleInsert = await db.prepare(
|
|
`REPLACE INTO articles (
|
|
id,
|
|
groupIndex,
|
|
categoryIndex,
|
|
sectionIndex,
|
|
groupId,
|
|
categoryId,
|
|
sectionId,
|
|
authorId,
|
|
title,
|
|
description,
|
|
hero,
|
|
status,
|
|
date,
|
|
sourceUrl,
|
|
componentCode,
|
|
componentCodeFiles,
|
|
keywords,
|
|
content,
|
|
path
|
|
) VALUES ( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`
|
|
)
|
|
|
|
for (let i = 0; i < content.sections.length; i++) {
|
|
const section = content.sections[i]
|
|
try {
|
|
await sectionInsert.run(
|
|
section.id,
|
|
section.id === 'reference' ? 99999 : i,
|
|
section.title,
|
|
section.description,
|
|
section.path,
|
|
section.sidebar_behavior
|
|
)
|
|
|
|
for (let c = 0; c < section.categories.length; c++) {
|
|
const category = section.categories[c]
|
|
await categoryInsert.run(
|
|
category.id,
|
|
category.title,
|
|
category.description,
|
|
section.id,
|
|
c,
|
|
category.path
|
|
)
|
|
}
|
|
} catch (e: any) {
|
|
throw Error(`could not add section to db, ${section.id}: ${e.message}`)
|
|
}
|
|
}
|
|
|
|
const articles = Object.values(content.articles) as Article[]
|
|
|
|
for (let i = 0; i < articles.length; i++) {
|
|
const article = articles[i]
|
|
if (!article.id) {
|
|
throw Error(`hey, article ${article.id} has no id`)
|
|
}
|
|
|
|
await articleInsert.run(
|
|
article.id,
|
|
article.groupIndex,
|
|
article.categoryIndex,
|
|
article.sectionIndex,
|
|
article.groupId,
|
|
article.categoryId,
|
|
article.sectionId,
|
|
article.author,
|
|
article.title,
|
|
article.description,
|
|
article.hero,
|
|
article.status,
|
|
article.date,
|
|
article.sourceUrl,
|
|
article.componentCode,
|
|
article.componentCodeFiles,
|
|
article.keywords.join(', '),
|
|
article.content,
|
|
article.path
|
|
)
|
|
|
|
await db.run(`DELETE FROM headings WHERE articleId = ?`, article.id)
|
|
|
|
await Promise.all(
|
|
getHeadingLinks(article.content ?? '').map((heading, i) =>
|
|
headingsInsert.run(
|
|
i,
|
|
article.id,
|
|
heading.level,
|
|
heading.title,
|
|
heading.slug,
|
|
heading.isCode,
|
|
`${article.path}#${heading.slug}`
|
|
)
|
|
)
|
|
)
|
|
}
|
|
}
|
|
|
|
const slugs = new GithubSlugger()
|
|
|
|
const MATCH_HEADINGS = /(?:^|\n)(#{1,6})\s+(.+?)(?=\n|$)/g
|
|
function getHeadingLinks(content: string) {
|
|
let match
|
|
const headings: ArticleHeadings = []
|
|
while ((match = MATCH_HEADINGS.exec(content)) !== null) {
|
|
slugs.reset()
|
|
headings.push({
|
|
level: match[1].length,
|
|
title: match[2].replaceAll('`', ''),
|
|
slug: slugs.slug(match[2], true),
|
|
isCode: match[2].startsWith('`'),
|
|
})
|
|
}
|
|
return headings
|
|
}
|