mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-22 10:33:22 +00:00
Start
This commit is contained in:
Samy Pessé
@@ -0,0 +1,6 @@
|
||||
# Go to https://app.gitbook.com/account/developer and create a new token
|
||||
# Copy the token and paste it in the .env file
|
||||
# GITBOOK_TOKEN=your_token_here
|
||||
|
||||
# Other options:
|
||||
# GITBOOK_API_URL=https://api.gitbook.com
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
{
|
||||
"extends": "next/core-web-vitals"
|
||||
"extends": "next/core-web-vitals"
|
||||
}
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
.next
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"printWidth": 100,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 4
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
/** @type {import('next').NextConfig} */
|
||||
const nextConfig = {}
|
||||
const nextConfig = {};
|
||||
|
||||
module.exports = nextConfig
|
||||
module.exports = nextConfig;
|
||||
|
||||
+31
-25
@@ -1,27 +1,33 @@
|
||||
{
|
||||
"name": "gitbook",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "next dev",
|
||||
"build": "next build",
|
||||
"start": "next start",
|
||||
"lint": "next lint"
|
||||
},
|
||||
"dependencies": {
|
||||
"react": "^18",
|
||||
"react-dom": "^18",
|
||||
"next": "13.5.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^5",
|
||||
"@types/node": "^20",
|
||||
"@types/react": "^18",
|
||||
"@types/react-dom": "^18",
|
||||
"autoprefixer": "^10",
|
||||
"postcss": "^8",
|
||||
"tailwindcss": "^3",
|
||||
"eslint": "^8",
|
||||
"eslint-config-next": "13.5.6"
|
||||
}
|
||||
"name": "gitbook",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "next dev",
|
||||
"build": "next build",
|
||||
"start": "next start",
|
||||
"lint": "next lint",
|
||||
"format": "prettier ./ --ignore-unknown --write",
|
||||
"format:check": "prettier ./ --ignore-unknown --list-different"
|
||||
},
|
||||
"dependencies": {
|
||||
"@gitbook/api": "^0.11.0",
|
||||
"clsx": "^2.0.0",
|
||||
"next": "13.5.6",
|
||||
"react": "^18",
|
||||
"react-dom": "^18",
|
||||
"server-only": "^0.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20",
|
||||
"@types/react": "^18",
|
||||
"@types/react-dom": "^18",
|
||||
"autoprefixer": "^10",
|
||||
"eslint": "^8",
|
||||
"eslint-config-next": "13.5.6",
|
||||
"postcss": "^8",
|
||||
"prettier": "^3.0.3",
|
||||
"tailwindcss": "^3",
|
||||
"typescript": "^5"
|
||||
}
|
||||
}
|
||||
|
||||
+5
-5
@@ -1,6 +1,6 @@
|
||||
module.exports = {
|
||||
plugins: {
|
||||
tailwindcss: {},
|
||||
autoprefixer: {},
|
||||
},
|
||||
}
|
||||
plugins: {
|
||||
tailwindcss: {},
|
||||
autoprefixer: {},
|
||||
},
|
||||
};
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>
|
||||
|
Before Width: | Height: | Size: 1.3 KiB |
@@ -1 +0,0 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 283 64"><path fill="black" d="M141 16c-11 0-19 7-19 18s9 18 20 18c7 0 13-3 16-7l-7-5c-2 3-6 4-9 4-5 0-9-3-10-7h28v-3c0-11-8-18-19-18zm-9 15c1-4 4-7 9-7s8 3 9 7h-18zm117-15c-11 0-19 7-19 18s9 18 20 18c6 0 12-3 16-7l-8-5c-2 3-5 4-8 4-5 0-9-3-11-7h28l1-3c0-11-8-18-19-18zm-10 15c2-4 5-7 10-7s8 3 9 7h-19zm-39 3c0 6 4 10 10 10 4 0 7-2 9-5l8 5c-3 5-9 8-17 8-11 0-19-7-19-18s8-18 19-18c8 0 14 3 17 8l-8 5c-2-3-5-5-9-5-6 0-10 4-10 10zm83-29v46h-9V5h9zM37 0l37 64H0L37 0zm92 5-27 48L74 5h10l18 30 17-30h10zm59 12v10l-3-1c-6 0-10 4-10 10v15h-9V17h9v9c0-5 6-9 13-9z"/></svg>
|
||||
|
Before Width: | Height: | Size: 629 B |
@@ -0,0 +1,30 @@
|
||||
import { headers } from 'next/headers';
|
||||
|
||||
import { api } from '@/lib/api';
|
||||
import { SpaceContent } from '@/components/SpaceContent';
|
||||
|
||||
export default async function Page(props: { params: { pathname?: string[] } }) {
|
||||
const {
|
||||
params: { pathname },
|
||||
} = props;
|
||||
|
||||
const headersList = headers();
|
||||
const spaceId = headersList.get('x-gitbook-space');
|
||||
|
||||
if (!spaceId) {
|
||||
throw new Error('Missing space id');
|
||||
}
|
||||
|
||||
const [{ data: space }, { data: revision }] = await Promise.all([
|
||||
api().spaces.getSpaceById(spaceId),
|
||||
api().spaces.getCurrentRevision(spaceId),
|
||||
]);
|
||||
|
||||
return (
|
||||
<SpaceContent
|
||||
space={space}
|
||||
revision={revision}
|
||||
pagePath={pathname ? pathname.join('/') : ''}
|
||||
/>
|
||||
);
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
@@ -2,26 +2,5 @@
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
||||
|
||||
:root {
|
||||
--foreground-rgb: 0, 0, 0;
|
||||
--background-start-rgb: 214, 219, 220;
|
||||
--background-end-rgb: 255, 255, 255;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--foreground-rgb: 255, 255, 255;
|
||||
--background-start-rgb: 0, 0, 0;
|
||||
--background-end-rgb: 0, 0, 0;
|
||||
}
|
||||
}
|
||||
|
||||
body {
|
||||
color: rgb(var(--foreground-rgb));
|
||||
background: linear-gradient(
|
||||
to bottom,
|
||||
transparent,
|
||||
rgb(var(--background-end-rgb))
|
||||
)
|
||||
rgb(var(--background-start-rgb));
|
||||
}
|
||||
|
||||
+9
-19
@@ -1,22 +1,12 @@
|
||||
import type { Metadata } from 'next'
|
||||
import { Inter } from 'next/font/google'
|
||||
import './globals.css'
|
||||
import { Inter } from 'next/font/google';
|
||||
import './globals.css';
|
||||
|
||||
const inter = Inter({ subsets: ['latin'] })
|
||||
const inter = Inter({ subsets: ['latin'] });
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: 'Create Next App',
|
||||
description: 'Generated by create next app',
|
||||
}
|
||||
|
||||
export default function RootLayout({
|
||||
children,
|
||||
}: {
|
||||
children: React.ReactNode
|
||||
}) {
|
||||
return (
|
||||
<html lang="en">
|
||||
<body className={inter.className}>{children}</body>
|
||||
</html>
|
||||
)
|
||||
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
||||
return (
|
||||
<html lang="en">
|
||||
<body className={inter.className}>{children}</body>
|
||||
</html>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,113 +0,0 @@
|
||||
import Image from 'next/image'
|
||||
|
||||
export default function Home() {
|
||||
return (
|
||||
<main className="flex min-h-screen flex-col items-center justify-between p-24">
|
||||
<div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
|
||||
<p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
|
||||
Get started by editing
|
||||
<code className="font-mono font-bold">src/app/page.tsx</code>
|
||||
</p>
|
||||
<div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
|
||||
<a
|
||||
className="pointer-events-none flex place-items-center gap-2 p-8 lg:pointer-events-auto lg:p-0"
|
||||
href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
By{' '}
|
||||
<Image
|
||||
src="/vercel.svg"
|
||||
alt="Vercel Logo"
|
||||
className="dark:invert"
|
||||
width={100}
|
||||
height={24}
|
||||
priority
|
||||
/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="relative flex place-items-center before:absolute before:h-[300px] before:w-[480px] before:-translate-x-1/2 before:rounded-full before:bg-gradient-radial before:from-white before:to-transparent before:blur-2xl before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-[240px] after:translate-x-1/3 after:bg-gradient-conic after:from-sky-200 after:via-blue-200 after:blur-2xl after:content-[''] before:dark:bg-gradient-to-br before:dark:from-transparent before:dark:to-blue-700 before:dark:opacity-10 after:dark:from-sky-900 after:dark:via-[#0141ff] after:dark:opacity-40 before:lg:h-[360px] z-[-1]">
|
||||
<Image
|
||||
className="relative dark:drop-shadow-[0_0_0.3rem_#ffffff70] dark:invert"
|
||||
src="/next.svg"
|
||||
alt="Next.js Logo"
|
||||
width={180}
|
||||
height={37}
|
||||
priority
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="mb-32 grid text-center lg:max-w-5xl lg:w-full lg:mb-0 lg:grid-cols-4 lg:text-left">
|
||||
<a
|
||||
href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
|
||||
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<h2 className={`mb-3 text-2xl font-semibold`}>
|
||||
Docs{' '}
|
||||
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
|
||||
->
|
||||
</span>
|
||||
</h2>
|
||||
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
|
||||
Find in-depth information about Next.js features and API.
|
||||
</p>
|
||||
</a>
|
||||
|
||||
<a
|
||||
href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
|
||||
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<h2 className={`mb-3 text-2xl font-semibold`}>
|
||||
Learn{' '}
|
||||
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
|
||||
->
|
||||
</span>
|
||||
</h2>
|
||||
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
|
||||
Learn about Next.js in an interactive course with quizzes!
|
||||
</p>
|
||||
</a>
|
||||
|
||||
<a
|
||||
href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
|
||||
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<h2 className={`mb-3 text-2xl font-semibold`}>
|
||||
Templates{' '}
|
||||
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
|
||||
->
|
||||
</span>
|
||||
</h2>
|
||||
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
|
||||
Explore the Next.js 13 playground.
|
||||
</p>
|
||||
</a>
|
||||
|
||||
<a
|
||||
href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
|
||||
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<h2 className={`mb-3 text-2xl font-semibold`}>
|
||||
Deploy{' '}
|
||||
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
|
||||
->
|
||||
</span>
|
||||
</h2>
|
||||
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
|
||||
Instantly deploy your Next.js site to a shareable URL with Vercel.
|
||||
</p>
|
||||
</a>
|
||||
</div>
|
||||
</main>
|
||||
)
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
import { ClassValue } from 'clsx';
|
||||
import { Paragraph } from './Paragraph';
|
||||
import { Heading } from './Heading';
|
||||
import { ListOrdered } from './ListOrdered';
|
||||
import { ListUnordered } from './ListUnordered';
|
||||
import { ListItem } from './ListItem';
|
||||
|
||||
export interface BlockProps<T> {
|
||||
block: T;
|
||||
style?: ClassValue;
|
||||
}
|
||||
|
||||
export function Block<T>(props: BlockProps<T>) {
|
||||
const { block } = props;
|
||||
|
||||
switch (block.type) {
|
||||
case 'paragraph':
|
||||
return <Paragraph {...props} />;
|
||||
case 'heading-1':
|
||||
case 'heading-2':
|
||||
case 'heading-3':
|
||||
return <Heading {...props} />;
|
||||
case 'list-ordered':
|
||||
return <ListOrdered {...props} />;
|
||||
case 'list-unordered':
|
||||
return <ListUnordered {...props} />;
|
||||
case 'list-item':
|
||||
return <ListItem {...props} />;
|
||||
default:
|
||||
return <div>Unsupported block {block.type}</div>;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
import clsx from 'clsx';
|
||||
import { ClassValue } from 'clsx';
|
||||
import { Block } from './Block';
|
||||
|
||||
export function Blocks<T>(props: {
|
||||
/** Blocks to render */
|
||||
nodes: T[];
|
||||
|
||||
/** HTML tag to use */
|
||||
tag?: string;
|
||||
|
||||
/** Style passed to the wrapper */
|
||||
style?: ClassValue;
|
||||
|
||||
/** Style passed to all blocks */
|
||||
blockStyle?: ClassValue;
|
||||
|
||||
/** Style passed to the first block */
|
||||
firstBlockStyle?: ClassValue;
|
||||
|
||||
/** Style passed to the last block */
|
||||
lastBlockStyle?: ClassValue;
|
||||
}) {
|
||||
const { nodes, tag: Tag = 'div', style, blockStyle, firstBlockStyle, lastBlockStyle } = props;
|
||||
|
||||
return (
|
||||
<Tag className={clsx(style)}>
|
||||
{nodes.map((node, index) => (
|
||||
<Block
|
||||
key={node.key}
|
||||
block={node}
|
||||
style={clsx(
|
||||
blockStyle,
|
||||
index === 0 && firstBlockStyle,
|
||||
index === nodes.length - 1 && lastBlockStyle,
|
||||
)}
|
||||
/>
|
||||
))}
|
||||
</Tag>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
import clsx from 'clsx';
|
||||
import { Blocks } from './Blocks';
|
||||
|
||||
/**
|
||||
* Render an entire document.
|
||||
*/
|
||||
export function DocumentView(props: { document: any }) {
|
||||
const { document } = props;
|
||||
|
||||
return <Blocks nodes={document.nodes} blockStyle={clsx('mt-6')} />;
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import clsx from 'clsx';
|
||||
import { BlockProps } from './Block';
|
||||
import { Inlines } from './Inlines';
|
||||
|
||||
export function Heading(props: BlockProps<any>) {
|
||||
const { block, style } = props;
|
||||
|
||||
const headingStyle = STYLES[block.type];
|
||||
|
||||
return (
|
||||
<headingStyle.tag className={clsx(headingStyle.className, style)}>
|
||||
<Inlines nodes={block.nodes} />
|
||||
</headingStyle.tag>
|
||||
);
|
||||
}
|
||||
|
||||
const STYLES = {
|
||||
'heading-1': {
|
||||
tag: 'h2',
|
||||
className: ['text-3xl', 'font-semibold'],
|
||||
},
|
||||
'heading-2': {
|
||||
tag: 'h3',
|
||||
className: ['text-2xl', 'font-semibold'],
|
||||
},
|
||||
'heading-3': {
|
||||
tag: 'h4',
|
||||
className: ['text-3xl', 'font-semibold'],
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,14 @@
|
||||
import { ClassValue } from 'clsx';
|
||||
|
||||
export interface InlineProps<T> {
|
||||
inline: T;
|
||||
}
|
||||
|
||||
export function Inline<T>(props: InlineProps<T>) {
|
||||
const { inline } = props;
|
||||
|
||||
switch (inline.type) {
|
||||
default:
|
||||
return <span>Unsupported inline {inline.type}</span>;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
import clsx from 'clsx';
|
||||
import { Text } from './Text';
|
||||
import { Inline } from './Inline';
|
||||
|
||||
export function Inlines<T>(props: { nodes: T[] }) {
|
||||
const { nodes } = props;
|
||||
|
||||
return (
|
||||
<>
|
||||
{nodes.map((node, index) => {
|
||||
if (node.object === 'text') {
|
||||
return <Text key={node.key} text={node} />;
|
||||
}
|
||||
|
||||
return <Inline key={node.key} inline={node} />;
|
||||
})}
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
import clsx from 'clsx';
|
||||
import { BlockProps } from './Block';
|
||||
import { Blocks } from './Blocks';
|
||||
|
||||
export function ListItem(props: BlockProps<any>) {
|
||||
const { block } = props;
|
||||
|
||||
return (
|
||||
<li className={clsx('text-base', 'font-normal')}>
|
||||
<Blocks nodes={block.nodes} blockStyle={clsx('mt-6', 'first:mt-0', 'last:mt-0')} />
|
||||
</li>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
import { BlockProps } from './Block';
|
||||
import { Blocks } from './Blocks';
|
||||
|
||||
export function ListOrdered(props: BlockProps<any>) {
|
||||
const { block, style } = props;
|
||||
|
||||
return <Blocks tag="ol" nodes={block.nodes} style={['list-decimal', 'ps-8', style]} />;
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
import { BlockProps } from './Block';
|
||||
import { Blocks } from './Blocks';
|
||||
|
||||
export function ListUnordered(props: BlockProps<any>) {
|
||||
const { block, style } = props;
|
||||
|
||||
return <Blocks tag="ul" nodes={block.nodes} style={['list-disc', 'ps-8', style]} />;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
import clsx from 'clsx';
|
||||
import { BlockProps } from './Block';
|
||||
import { Inlines } from './Inlines';
|
||||
|
||||
export function Paragraph(props: BlockProps<any>) {
|
||||
const { block, style } = props;
|
||||
|
||||
return (
|
||||
<p className={clsx('text-base', 'font-normal', style)}>
|
||||
<Inlines nodes={block.nodes} />
|
||||
</p>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
import React from 'react';
|
||||
|
||||
export function Text(props: { text: any }) {
|
||||
const { text } = props;
|
||||
|
||||
return (
|
||||
<>
|
||||
{text.leaves.map((leaf, index) => {
|
||||
// TODO: marks
|
||||
return <React.Fragment key={index}>{leaf.text}</React.Fragment>;
|
||||
})}
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export * from './DocumentView';
|
||||
@@ -0,0 +1,27 @@
|
||||
import { pageHref } from '@/lib/links';
|
||||
import { Space } from '@gitbook/api';
|
||||
|
||||
import clsx from 'clsx';
|
||||
import Link from 'next/link';
|
||||
|
||||
/**
|
||||
* Render the header for the space.
|
||||
*/
|
||||
export function Header(props: { space: Space }) {
|
||||
const { space } = props;
|
||||
|
||||
return (
|
||||
<div
|
||||
className={clsx(
|
||||
'h-16',
|
||||
'sticky top-0 z-40 w-full backdrop-blur flex-none transition-colors duration-500 lg:z-50 lg:border-b lg:border-slate-900/10 dark:border-slate-50/[0.06] bg-white/95 supports-backdrop-blur:bg-white/60 dark:bg-transparent',
|
||||
)}
|
||||
>
|
||||
<div className={clsx('max-w-8xl mx-auto')}>
|
||||
<Link href={pageHref('')}>
|
||||
<h1>{space.title}</h1>
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export * from './Header';
|
||||
@@ -0,0 +1,14 @@
|
||||
import { Revision, RevisionPageDocument, Space } from '@gitbook/api';
|
||||
import { PageHeader } from './PageHeader';
|
||||
import { PageDocument } from './PageDocument';
|
||||
|
||||
export function PageBody(props: { space: Space; revision: Revision; page: RevisionPageDocument }) {
|
||||
const { space, revision, page } = props;
|
||||
|
||||
return (
|
||||
<main>
|
||||
<PageHeader page={page} />
|
||||
<PageDocument space={space} revision={revision} page={page} />
|
||||
</main>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
import { api } from '@/lib/api';
|
||||
import { Revision, RevisionPageDocument, Space } from '@gitbook/api';
|
||||
import { DocumentView } from '../DocumentView';
|
||||
|
||||
/**
|
||||
* Fetch the document for the page and render it.
|
||||
*/
|
||||
export async function PageDocument(props: {
|
||||
space: Space;
|
||||
revision: Revision;
|
||||
page: RevisionPageDocument;
|
||||
}) {
|
||||
const { space, revision, page } = props;
|
||||
|
||||
const {
|
||||
data: { document },
|
||||
} = await api().spaces.getPageInRevisionById(space.id, revision.id, page.id);
|
||||
|
||||
return <DocumentView document={document} />;
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { RevisionPageDocument } from '@gitbook/api';
|
||||
import clsx from 'clsx';
|
||||
|
||||
export function PageHeader(props: { page: RevisionPageDocument }) {
|
||||
const { page } = props;
|
||||
|
||||
return (
|
||||
<header>
|
||||
<h1 className={clsx('text-4xl', 'font-bold')}>{page.title}</h1>
|
||||
{page.description ? (
|
||||
<p className={clsx('mt-3', 'text-lg', 'text-slate-600')}>{page.description}</p>
|
||||
) : null}
|
||||
</header>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export * from './PageBody';
|
||||
@@ -0,0 +1,95 @@
|
||||
import { Revision, RevisionPage, RevisionPageDocument, Space } from '@gitbook/api';
|
||||
|
||||
import { TableOfContents } from '@/components/TableOfContents';
|
||||
import clsx from 'clsx';
|
||||
import { Header } from '@/components/Header';
|
||||
import { PageBody } from '@/components/PageBody';
|
||||
import { notFound, redirect } from 'next/navigation';
|
||||
import { pageHref } from '@/lib/links';
|
||||
|
||||
/**
|
||||
* Render the entire content of the space (header, table of contents, footer, and page content).
|
||||
*/
|
||||
export function SpaceContent(props: { space: Space; revision: Revision; pagePath: string }) {
|
||||
const { space, revision, pagePath } = props;
|
||||
const activePage = resolvePagePath(revision, pagePath);
|
||||
|
||||
return (
|
||||
<div>
|
||||
<Header space={space} />
|
||||
<div className={clsx('max-w-8xl mx-auto px-4 sm:px-6 md:px-8')}>
|
||||
<TableOfContents revision={revision} activePage={activePage} />
|
||||
<div className={clsx('lg:pl-[19.5rem]')}>
|
||||
<div className={clsx('max-w-3xl', 'py-8', 'px-4')}>
|
||||
<PageBody space={space} revision={revision} page={activePage} />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function resolvePagePath(revision: Revision, pagePath: string): RevisionPageDocument {
|
||||
const resolveFirstDocument = (pages: RevisionPage[]): RevisionPageDocument | undefined => {
|
||||
for (const page of pages) {
|
||||
if (page.type === 'link') {
|
||||
continue;
|
||||
}
|
||||
|
||||
return resolvePage(page);
|
||||
}
|
||||
|
||||
return;
|
||||
};
|
||||
|
||||
const resolvePage = (page: RevisionPage): RevisionPageDocument => {
|
||||
if (page.type === 'group') {
|
||||
const firstDocument = resolveFirstDocument(page.pages);
|
||||
if (firstDocument) {
|
||||
redirect(pageHref(firstDocument.path));
|
||||
}
|
||||
|
||||
notFound();
|
||||
} else if (page.type === 'link') {
|
||||
notFound();
|
||||
}
|
||||
|
||||
return page;
|
||||
};
|
||||
|
||||
const iteratePages = (pages: RevisionPage[]): RevisionPageDocument | undefined => {
|
||||
for (const page of pages) {
|
||||
if (page.type === 'link') {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (page.path !== pagePath) {
|
||||
// TODO: can be optimized to count the number of slashes and skip the entire subtree
|
||||
const result = iteratePages(page.pages);
|
||||
if (result) {
|
||||
return result;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
return resolvePage(page);
|
||||
}
|
||||
};
|
||||
|
||||
if (!pagePath) {
|
||||
const firstPage = resolveFirstDocument(revision.pages);
|
||||
if (!firstPage) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
return firstPage;
|
||||
}
|
||||
|
||||
const result = iteratePages(revision.pages);
|
||||
if (!result) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export * from './SpaceContent';
|
||||
@@ -0,0 +1,36 @@
|
||||
import { RevisionPageDocument } from '@gitbook/api';
|
||||
import { clsx } from 'clsx';
|
||||
import Link from 'next/link';
|
||||
import { PagesList } from './PagesList';
|
||||
import { pageHref } from '@/lib/links';
|
||||
|
||||
export function PageDocumentItem(props: {
|
||||
page: RevisionPageDocument;
|
||||
activePage: RevisionPageDocument;
|
||||
}) {
|
||||
const { page, activePage } = props;
|
||||
|
||||
return (
|
||||
<li className={clsx('flex', 'flex-col', 'mb-0.5')}>
|
||||
<Link
|
||||
href={pageHref(page.path || '')}
|
||||
className={clsx(
|
||||
'rounded',
|
||||
'px-2',
|
||||
'py-1.5',
|
||||
'text-sm',
|
||||
'transition-colors',
|
||||
'duration-200',
|
||||
activePage.id === page.id
|
||||
? ['bg-primary-100', 'text-primary-500', 'font-semibold']
|
||||
: ['hover:bg-slate-100', 'text-slate-500', 'font-normal'],
|
||||
)}
|
||||
>
|
||||
{page.title}
|
||||
</Link>
|
||||
{page.pages && page.pages.length ? (
|
||||
<PagesList pages={page.pages} style={clsx('ms-4')} activePage={activePage} />
|
||||
) : null}
|
||||
</li>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
import { RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
|
||||
import { clsx } from 'clsx';
|
||||
import { PagesList } from './PagesList';
|
||||
|
||||
export function PageGroupItem(props: {
|
||||
page: RevisionPageGroup;
|
||||
activePage: RevisionPageDocument;
|
||||
}) {
|
||||
const { page, activePage } = props;
|
||||
|
||||
return (
|
||||
<li className={clsx('flex', 'flex-col', 'my-3')}>
|
||||
<div className={clsx('px-2', 'py-1.5', 'text-m', 'text-slate-900', 'font-medium')}>
|
||||
{page.title}
|
||||
</div>
|
||||
{page.pages && page.pages.length ? (
|
||||
<PagesList pages={page.pages} activePage={activePage} />
|
||||
) : null}
|
||||
</li>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
import { RevisionPage, RevisionPageDocument } from '@gitbook/api';
|
||||
import { ClassValue, clsx } from 'clsx';
|
||||
import { PageDocumentItem } from './PageDocumentItem';
|
||||
import { PageGroupItem } from './PageGroupItem';
|
||||
|
||||
export function PagesList(props: {
|
||||
pages: RevisionPage[];
|
||||
activePage: RevisionPageDocument;
|
||||
style?: ClassValue;
|
||||
}) {
|
||||
const { pages, activePage, style } = props;
|
||||
|
||||
return (
|
||||
<ul className={clsx('flex', 'flex-col', style)}>
|
||||
{pages.map((page) => {
|
||||
if (page.type === 'group') {
|
||||
return <PageGroupItem key={page.id} page={page} activePage={activePage} />;
|
||||
}
|
||||
|
||||
return <PageDocumentItem key={page.id} page={page} activePage={activePage} />;
|
||||
})}
|
||||
</ul>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
import { Revision, RevisionPageDocument } from '@gitbook/api';
|
||||
import { clsx } from 'clsx';
|
||||
import { PagesList } from './PagesList';
|
||||
import { Trademark } from './Trademark';
|
||||
|
||||
export function TableOfContents(props: { revision: Revision; activePage: RevisionPageDocument }) {
|
||||
const { revision, activePage } = props;
|
||||
|
||||
return (
|
||||
<aside
|
||||
className={clsx(
|
||||
'flex-col',
|
||||
'hidden lg:flex fixed z-20 inset-0 top-16 left-[max(0px,calc(50%-45rem))] right-auto w-[19rem]',
|
||||
)}
|
||||
>
|
||||
<div className={clsx('flex-1', 'overflow-y-auto', 'pt-6 pb-14 pl-8 pr-6')}>
|
||||
<PagesList pages={revision.pages} activePage={activePage} />
|
||||
</div>
|
||||
<Trademark />
|
||||
</aside>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
import clsx from 'clsx';
|
||||
|
||||
/**
|
||||
* Link to the GitBook platform.
|
||||
*/
|
||||
export function Trademark() {
|
||||
return (
|
||||
<div className={clsx('absolute', 'bottom-0', 'right-0', 'left-0', 'flex', 'flex-col')}>
|
||||
<a
|
||||
href="https://www.gitbook.com"
|
||||
className={clsx(
|
||||
'text-m',
|
||||
'text-slate-500',
|
||||
'font-normal',
|
||||
'px-4',
|
||||
'py-3',
|
||||
'mx-4',
|
||||
'my-4',
|
||||
'rounded-lg',
|
||||
'bg-white',
|
||||
'hover:bg-slate-50',
|
||||
)}
|
||||
>
|
||||
Powered by GitBook
|
||||
</a>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
export * from './TableOfContents';
|
||||
@@ -0,0 +1,19 @@
|
||||
import 'server-only';
|
||||
|
||||
import { headers } from 'next/headers';
|
||||
import { GitBookAPI } from '@gitbook/api';
|
||||
|
||||
/**
|
||||
* Create an API client for the current request.
|
||||
*/
|
||||
export function api(): GitBookAPI {
|
||||
const headersList = headers();
|
||||
const apiToken = headersList.get('x-gitbook-token');
|
||||
|
||||
const gitbook = new GitBookAPI({
|
||||
authToken: apiToken || process.env.GITBOOK_TOKEN,
|
||||
endpoint: process.env.GITBOOK_API_URL,
|
||||
});
|
||||
|
||||
return gitbook;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
import 'server-only';
|
||||
|
||||
import { headers } from 'next/headers';
|
||||
|
||||
/**
|
||||
* Create a link to a page path in the current space.
|
||||
*/
|
||||
export function pageHref(pagePath: string): string {
|
||||
const headersList = headers();
|
||||
const basePath = headersList.get('x-gitbook-basepath') ?? '';
|
||||
|
||||
return `${basePath}/${pagePath.startsWith('/') ? pagePath.slice(1) : pagePath}`;
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
import { NextResponse } from 'next/server';
|
||||
import { NextRequest } from 'next/server';
|
||||
|
||||
/**
|
||||
* Rewrite the request to extract the spaceId from the URL
|
||||
* and pass it as a header.
|
||||
*/
|
||||
export function middleware(request: NextRequest) {
|
||||
const url = new URL(request.url);
|
||||
const [space, ...pathRest] = url.pathname.slice(1).split('/');
|
||||
|
||||
const headers = new Headers(request.headers);
|
||||
headers.set('x-gitbook-space', space);
|
||||
headers.set('x-gitbook-basepath', `/${space}`);
|
||||
|
||||
url.pathname = `/${pathRest.join('/')}`;
|
||||
|
||||
return NextResponse.rewrite(url, {
|
||||
headers,
|
||||
});
|
||||
}
|
||||
|
||||
export const config = {
|
||||
matcher: '/((?!api|_next/static|_next/image|favicon.ico).*)',
|
||||
};
|
||||
+16
-17
@@ -1,20 +1,19 @@
|
||||
import type { Config } from 'tailwindcss'
|
||||
import type { Config } from 'tailwindcss';
|
||||
import colors from 'tailwindcss/colors';
|
||||
|
||||
const config: Config = {
|
||||
content: [
|
||||
'./src/pages/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
'./src/components/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
'./src/app/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
],
|
||||
theme: {
|
||||
extend: {
|
||||
backgroundImage: {
|
||||
'gradient-radial': 'radial-gradient(var(--tw-gradient-stops))',
|
||||
'gradient-conic':
|
||||
'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
|
||||
},
|
||||
content: [
|
||||
'./src/pages/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
'./src/components/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
'./src/app/**/*.{js,ts,jsx,tsx,mdx}',
|
||||
],
|
||||
theme: {
|
||||
extend: {
|
||||
colors: {
|
||||
primary: colors.blue,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
plugins: [],
|
||||
}
|
||||
export default config
|
||||
plugins: [],
|
||||
};
|
||||
export default config;
|
||||
|
||||
+25
-25
@@ -1,27 +1,27 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"noEmit": true,
|
||||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "preserve",
|
||||
"incremental": true,
|
||||
"plugins": [
|
||||
{
|
||||
"name": "next"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"@/*": ["./src/*"]
|
||||
}
|
||||
},
|
||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
|
||||
"exclude": ["node_modules"]
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"noEmit": true,
|
||||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"jsx": "preserve",
|
||||
"incremental": true,
|
||||
"plugins": [
|
||||
{
|
||||
"name": "next"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"@/*": ["./src/*"]
|
||||
}
|
||||
},
|
||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user