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>
97 lines
2.7 KiB
TypeScript
97 lines
2.7 KiB
TypeScript
import { Header } from '@/components/Header'
|
|
import { Sidebar } from '@/components/Sidebar'
|
|
import { SearchResult } from '@/types/search-types'
|
|
import { getDb } from '@/utils/ContentDatabase'
|
|
import Link from 'next/link'
|
|
import process from 'process'
|
|
|
|
const HOST_URL =
|
|
process.env.NODE_ENV === 'development'
|
|
? 'http://localhost:3001'
|
|
: process.env.NEXT_PUBLIC_SITE_URL ?? 'https://www.tldraw.dev'
|
|
|
|
export default async function SearchResultsPage({
|
|
searchParams,
|
|
}: {
|
|
searchParams: { q: string; t: string }
|
|
}) {
|
|
const query = searchParams.q?.toString() as string
|
|
const type = searchParams.t?.toString() as string
|
|
|
|
const db = await getDb()
|
|
const sidebar = await db.getSidebarContentList({})
|
|
|
|
let results: {
|
|
articles: SearchResult[]
|
|
apiDocs: SearchResult[]
|
|
error: null | string
|
|
} = {
|
|
articles: [],
|
|
apiDocs: [],
|
|
error: null,
|
|
}
|
|
|
|
if (query) {
|
|
const endPoint =
|
|
type === 'ai' ? `${HOST_URL}/api/ai?q=${query}` : `${HOST_URL}/api/search?q=${query}`
|
|
const res = await fetch(endPoint)
|
|
if (!res.ok) {
|
|
results.error = await res.text()
|
|
} else {
|
|
const json = await res.json()
|
|
results = json.results
|
|
}
|
|
}
|
|
|
|
return (
|
|
<>
|
|
<Header searchQuery={query} searchType={type} />
|
|
<Sidebar {...sidebar} searchQuery={query} searchType={type} />
|
|
<main className="article list">
|
|
<div className="page-header">
|
|
<h2>{`Found ${
|
|
results.articles.length + results.apiDocs.length
|
|
} results for "${query}"`}</h2>
|
|
<div className="search__results__switcher">
|
|
{type === 'ai' ? (
|
|
<Link href={`/search-results?q=${query}&t=n`}>Search again using exact match...</Link>
|
|
) : (
|
|
// TODO: replace emoji with icon
|
|
<Link href={`/search-results?q=${query}&t=ai`}>✨ Search again using AI...</Link>
|
|
)}
|
|
</div>
|
|
</div>
|
|
<ResultsList results={results.articles} type={type} />
|
|
{results.articles.length > 0 && results.apiDocs.length > 0 && (
|
|
<>
|
|
<hr />
|
|
<h2>API Docs</h2>
|
|
</>
|
|
)}
|
|
{results.apiDocs.length > 0 && <ResultsList results={results.apiDocs} type={type} />}
|
|
</main>
|
|
</>
|
|
)
|
|
}
|
|
|
|
function ResultsList({ results, type }: { results: SearchResult[]; type?: string }) {
|
|
return (
|
|
<ul className="search__results__list">
|
|
{results.map((result) => (
|
|
<Link className="search__results__link" key={result.id} href={`${result.url}`}>
|
|
<li className="search__results__article">
|
|
<div className="search__results__article__details">
|
|
<h4>{result.subtitle}</h4>
|
|
{type === 'ai' && (
|
|
<span className="search__results__article__score">
|
|
{(result.score * 100).toFixed()}%
|
|
</span>
|
|
)}
|
|
</div>
|
|
<h3>{result.title}</h3>
|
|
</li>
|
|
</Link>
|
|
))}
|
|
</ul>
|
|
)
|
|
}
|