Merge branch 'main' into perf/lazy-webframes-lighter-markup

A page can hold a hundred expandables, each hiding a table, and the whole
document restyles when any of them opens. Give them `content-visibility`,
as OpenAPI blocks already have, so the off-screen ones do no style or
layout work. The DOM is untouched, so find-in-page and #anchors still work.

.agents/skills/write-pr-description/SKILL.md

@@ -0,0 +1,48 @@
+---
+name: write-pr-description
+description: Write a concise, product-focused PR description from the changes and available discussion. Use when asked for a PR summary or description.
+---
+
+# Write a PR description
+
+Read the full branch diff and commit history against the PR's base branch, not just the latest commit. Use the PR discussion and linked issues for context when available. The PR's changes are the source of truth for what ships if an issue describes something different.
+
+Write for contributors and reviewers who may not know the area. Lead with what changes, prefer user or product impact when supported, and include implementation details only when they help review. Keep the proposed changes short, using bullets only when useful.
+
+Include relevant validation and screenshots when available. Do not claim checks passed unless they ran. Use only information appropriate for a public repository; do not copy private issue details or customer information into the description.
+
+## Template and changelog
+
+Read `.github/pull_request_template.md` immediately before writing. Preserve its required section names and order. Include `Proposed changes` and `Changelog`; omit `Demo` when there is nothing to show. Add optional `Context` before `Changelog` only when it meets the rule below.
+
+Write a short changelog entry describing what shipped. Use `[Feature]` for user-facing additions or improvements, `[Fix]` for user-facing bug fixes, and `[Chore]` for internal maintenance. For features and fixes, say what users can do or what no longer goes wrong in plain words. Keep chores useful to teammates without inventing user impact. Remove unused examples and placeholders. Usually one entry is enough; use more only for distinct changes. The PR changelog does not replace any changeset required by `AGENTS.md`.
+
+## Optional context
+
+Write `Proposed changes` and `Changelog` first. Add `Context` only when it tells someone unfamiliar with the area something material that the changelog does not. `Problem` names a concrete failure or limitation supported by the PR or discussion. `Outcome` names what this PR delivers at its actual scope. Omit the section if either field would repeat the changelog, describe only implementation, or guess at an impact.
+
+```markdown
+## Context
+
+**Problem:** <concrete failure or limitation>
+
+**Outcome:** <result delivered by this PR>
+```
+
+Keep each field to 1–2 short, non-technical sentences. Prefer user or product impact when supported. For infrastructure changes, explain the failure or limitation they caused. Do not invent an actor, customer segment, ownership, or impact, or force the change into a user story. Do not turn a preparatory change into a claim that the whole workflow is fixed. Keep the roles distinct: `Context` explains why this matters, `Changelog` says what shipped, and `Proposed changes` can explain implementation.
+
+Examples:
+
+- A dependency bump with no demonstrated user effect needs no `Context`.
+- If creating the first change request leaves the user on an empty screen, say that it now opens after creation. Leave the animation-listener details in `Proposed changes`.
+- If a PR indexes links for later checks, describe the indexing result. Do not claim every link has already been checked.
+
+## Writing pass
+
+- Use plain words and direct verbs: "use" instead of "leverage", "help" instead of "facilitate". Prefer active voice when the actor is known.
+- Name the concrete behavior instead of saying "improves the experience" or "makes it more robust". Support performance claims with measurements.
+- Cut filler, promotional language, and generic conclusions. If a sentence could fit almost any PR, make it specific or delete it.
+- Keep one idea per sentence and use consistent names. Remove redundant hedging without hiding real uncertainty.
+- Avoid "not just X, but Y", forced groups of three, em dashes, decorative emojis, and unnecessary bold text.
+
+Return the description in a Markdown code block unless asked to update the PR. When asked to update it, apply the description with `gh pr edit` using a body file.

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/bump-next-16-4-3.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Bump Next.js to 16.4.3, keeping the dev-mode OOM patch.

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
+    "changelog": "@changesets/cli/changelog",
+    "commit": false,
+    "fixed": [],
+    "linked": [],
+    "access": "public",
+    "baseBranch": "main",
+    "updateInternalDependencies": "patch",
+    "ignore": []
+}

.changeset/dedupe-preconnects.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Preconnect each asset origin once, skip same-origin icon URLs, and open the fonts preconnect in CORS mode so font requests can reuse it.

.changeset/forward-ask-user-agent.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Forward the visitor's user agent on ask and Assistant calls so questions are classified by who asked.

.changeset/lazy-inline-expressions.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Load the inline expression runtime only on pages whose code blocks or text use expressions, so other pages ship less JavaScript.

.changeset/lazy-webframes.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/react-contentkit": patch
+---
+
+Load a webframe only once it is near the viewport. A page can hold hundreds of them inside collapsed expandables, and loading every one on mount held up the first paint.

.changeset/lighter-document-markup.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Pack the class lists that every block, heading anchor and table cell repeats into shared CSS classes, and take each column's width from the table rather than from a style attribute on every cell, so a large page carries far less markup. Off-screen expandables also skip their rendering work.

.changeset/llms-full-size-pagination.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Split llms-full.txt into parts by size so large sites no longer fail with "content too large"

.changeset/mcp-get-page-redirects.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Follow site and space redirects when the MCP getPage tool resolves a page URL.

.changeset/models-search-input.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Add a search input to filter models by name on OpenAPI models pages.

.changeset/native-external-link-clicks.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Let analytics tools like GA4 track outbound link clicks by using native link navigation.

.changeset/partitioned-visitor-cookies.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Set `Partitioned` on visitor cookies set inside an iframe so authenticated embeds work cross-site.

.changeset/quiet-secondary-colour.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Support a secondary brand colour for secondary buttons and `$secondary` text, background, icon and tag colours. Sites without one render as before.

.changeset/resolve-full-url.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Resolve the published content with the full URL in a single lookup and always send the visitor country.

.changeset/rss-feed-html-content.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Keep lists, paragraphs and code blocks as HTML in Updates RSS feeds, instead of running all the text together

.changeset/scope-preview-customization-site-space.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Only apply a site preview customization override to the section or variant it was made for.

.changeset/soft-break-after-button.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Render soft line breaks in paragraphs that contain buttons.

.changeset/truncate-long-tab-titles.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Truncate long tab titles one by one and show the selected tab's full title, instead of hiding tabs behind a "…" menu

.claude/launch.json

@@ -0,0 +1,12 @@
+{
+    "version": "0.0.1",
+    "configurations": [
+        {
+            "name": "🚀 Dev server",
+            "runtimeExecutable": "sh",
+            "runtimeArgs": ["-c", "bun install && bun dev"],
+            "port": 3000,
+            "autoPort": false
+        }
+    ]
+}

.claude/skills/write-pr-description

@@ -0,0 +1 @@
+../../.agents/skills/write-pr-description

.codex/skills/write-pr-description

@@ -0,0 +1 @@
+../../.agents/skills/write-pr-description

.editorconfig

@@ -1,10 +1,10 @@
-# editorconfig.org
+# Stop editors from looking for .editorconfig files in parent directories.
 root = true
 
 [*]
+charset = utf-8
+end_of_line = lf
 indent_style = space
 indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
 insert_final_newline = true
+max_line_length = 100

.eslintignore

@@ -1,4 +0,0 @@
-docs/**/*
-_book/**/*
-node_modules/**/*
-test/**/*

.eslintrc

@@ -1,11 +0,0 @@
-{
-    "env": {
-        "node": true,
-        "browser": true,
-        "mocha": true
-    },
-    "globals": {
-        "expect": true
-    },
-    "extends": "gitbook"
-}

.github/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to GitBook
+
+> _For help, support and product questions, head to our [GitHub Community](https://github.com/orgs/GitbookIO/discussions)._
+
+Thanks for helping make GitBook better. This repository holds the open source renderer behind every published GitBook site, and the team reads everything that comes in here.
+
+## Ways to contribute
+
+-   **Open an issue.** Report a bug, suggest a feature, or tell us when something feels off. This is the most useful thing you can do.
+-   **Join the conversation.** Share ideas and help others in [GitHub Community](https://github.com/orgs/GitbookIO/discussions).
+-   **Build with GitBook.** Publish your docs, try new features early, and tell us what works and what doesn't.
+
+## Issues instead of pull requests
+
+Pull requests are limited to the GitBook team. If you've found a bug or want something to change, please [open an issue](https://github.com/GitbookIO/gitbook/issues/new/choose) instead.
+
+This isn't because we don't want your help. Every change here ships to every published GitBook site, so we need to own each one from start to finish. A clear issue often helps us more than a pull request: it tells us what's wrong and why, and lets us fix it in a way that fits the rest of the codebase.
+
+A good issue includes:
+
+-   What you expected to happen, and what happened instead
+-   A link to a published GitBook site that shows the problem, if you have one
+-   Steps to reproduce it, plus screenshots or a recording for anything visual
+-   Your browser and OS, if it looks like it might matter
+
+Before opening one, [search existing issues](https://github.com/GitbookIO/gitbook/issues). If someone has already reported it, add a 👍 or any extra details you have.
+
+Already fixed it in your fork? Link the branch or commit in your issue. We may open a pull request from it, and your commits keep your name.
+
+If you open a pull request anyway, we'll close it and point you here. Nothing personal, and we'd still love the issue.
+
+## Reach out
+
+Not sure if it's a bug? Have a half-formed idea? Open an issue or start a [discussion](https://github.com/orgs/GitbookIO/discussions) anyway. We'd much rather hear from you than not, and no report is too small.
+
+Spotted a wrong or missing translation? Open an issue with the string and the wording you'd suggest.
+
+## Using AI
+
+You're welcome to use AI to help you write an issue. Please read and check what it produces before you post: reports that are long, vague or unverified take time away from fixing real problems, and we may close them without a reply.
+
+## Running locally
+
+You don't need a local setup to open an issue, but it can help you reproduce a problem or self-host the renderer.
+
+### Prerequisites
+
+-   [Node.js](https://nodejs.org/en) (see "engines" in `package.json`)
+-   [Bun](https://bun.sh/) (see "packageManager" in `package.json`)
+
+### Setup
+
+1. Use the project's version of Node:
+
+```bash
+nvm use
+```
+
+2. Install dependencies:
+
+```bash
+bun install
+```
+
+3. Start the development server:
+
+```bash
+bun dev
+```
+
+Other commands:
+
+-   `bun lint`: Lint the code using Oxlint
+-   `bun lint:fix`: Automatically fix lint issues using Oxlint
+-   `bun format`: Format the code using Oxfmt
+-   `bun format:check`: Check formatting without changing files
+-   `bun typecheck`: Run TypeScript type checking
+-   `bun unit`: Run unit tests
+-   `bun e2e`: Run end-to-end tests
+
+### Preview a site
+
+With the development server running, any published GitBook site can be rendered through your local version at `http://localhost:3000/url/<published-url>`. For example, visit `http://localhost:3000/url/gitbook.com/docs` to see our own docs.
+
+The site must be [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to render locally.
+
+## License
+
+The renderer is distributed under the [GNU GPLv3 License](https://github.com/GitbookIO/gitbook/blob/main/LICENSE). If you distribute the code, you must keep the source code public. To use it in a private repository, you need a [commercial license](https://www.gitbook.com/pricing).

.github/ISSUE_TEMPLATE.md

@@ -1,30 +0,0 @@
-<!--
-              IMPORTANT NOTICE
-  Only post things related to the gitbook CLI
-  For GitBook.com, the Editor, or anything else
-  please go to
-  https://github.com/GitbookIO/feedback/issues
-
-  Please open separate issues for each bug report.
--->
-
-
-### What is the current behavior?
-
-<!--
-  - For bugs, provide the steps to reproduce
-  - Provide the GitBook version being used (`gitbook -V`)
-  - Provide system informations (OS and version)
-  - Provide your username and the URL of the book
--->
-
-
-
-### What is the expected behavior?
-
-
-
-<!--
-  Thank you for giving us your feedback!
-  -- The GitBook Team
--->

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Something not working as expected? Let us look into it
+labels: bug
+---
+
+## Bug description
+
+_Please describe._  
+_If this affects the front-end, screenshots would be of great help._
+
+## How to reproduce
+
+1.
+2.
+3.
+
+## Additional context

.github/actions/gradual-deploy-cloudflare/action.yaml

@@ -0,0 +1,83 @@
+name: Gradual Deploy to Cloudflare
+description: Use gradual deployment to deploy to Cloudflare. This action will upload the middleware and server versions to Cloudflare and kept them bound together
+inputs:
+    apiToken:
+        description: 'Cloudflare API token'
+        required: true
+    accountId:
+        description: 'Cloudflare account ID'
+        required: true
+    environment:
+        description: 'Cloudflare environment to deploy to (staging, production, preview)'
+        required: true
+    middlewareVersionId:
+        description: 'Middleware version ID to deploy'
+        required: true
+    serverVersionId:
+        description: 'Server version ID to deploy'
+        required: true
+outputs:
+    deployment-url:
+        description: 'Deployment URL'
+        value: ${{ steps.deploy_middleware.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - id: wrangler_status
+          name: Check wrangler deployment status
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+        # This step is used to get the version ID that is currently deployed to Cloudflare.
+        - id: extract_current_version
+          name: Extract current version
+          shell: bash
+          run: |
+              version_id=$(echo "${{ steps.wrangler_status.outputs.command-output }}" | grep -A 3 "(100%)" | grep -oP '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - id: deploy_server
+          name: Deploy server to Cloudflare at 0%
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+        # Since we use version overrides headers, we can directly deploy the middleware to 100%.
+        - id: deploy_middleware
+          name: Deploy middleware to Cloudflare at 100%
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+
+        - name: Deploy server to Cloudflare at 100%
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+        - name: Outputs
+          shell: bash
+          env:
+              DEPLOYMENT_URL: ${{ steps.deploy_middleware.outputs.deployment-url }}
+          run: |
+              echo "URL: ${{ steps.deploy_middleware.outputs.deployment-url }}"

.github/composite/deploy-cloudflare/action.yaml

@@ -0,0 +1,145 @@
+name: 'Deploy cloudflare'
+description: 'Deploy GitBook to Cloudflare'
+inputs:
+    opItem:
+        description: '1Password item to load secrets from'
+        required: true
+    opServiceAccount:
+        description: '1Password service account token'
+        required: true
+    apiToken:
+        description: 'Cloudflare API token'
+        required: true
+    accountId:
+        description: 'Cloudflare account ID'
+        required: true
+    environment:
+        description: 'Cloudflare environment to deploy to (staging, production, preview)'
+        required: true
+    deploy:
+        description: 'Deploy as main version for all traffic instead of uploading versions'
+        required: true
+    commitTag:
+        description: 'Commit branch to associate with the deployment'
+        required: true
+    commitMessage:
+        description: 'Commit message to associate with the deployment'
+        required: true
+outputs:
+    deployment-url:
+        description: 'Deployment URL'
+        value: ${{ steps.upload_middleware.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup Bun
+          uses: ./.github/composite/setup-bun
+        - name: Install dependencies
+          run: bun install --frozen-lockfile
+          shell: bash
+          env:
+              PUPPETEER_SKIP_DOWNLOAD: 1
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+              OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+              GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+              GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+              GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+              NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
+              GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+              GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+              GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+              GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+              GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+              GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
+              GITBOOK_SITE_OAUTH_SIGNING_SECRET: ${{ inputs.opItem }}/GITBOOK_SITE_OAUTH_SIGNING_SECRET
+              GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
+              GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
+              GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
+              GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
+              GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL_2
+              GITBOOK_IMAGE_RESIZE_SALT: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SALT
+              GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
+              GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+              GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
+        - name: Build worker
+          run: bun run turbo build:cloudflare
+          env:
+              GITBOOK_RUNTIME: cloudflare
+              GITBOOK_BLOCK_SEARCH_INDEXATION: ${{ inputs.environment == 'preview' && 'true' || '' }}
+              GITBOOK_ALLOW_CUSTOMIZATION_OVERRIDE: ${{ inputs.environment == 'preview' && 'true' || '' }}
+              GITBOOK_DISABLE_INSIGHTS: ${{ inputs.environment == 'preview' && 'true' || '' }}
+          shell: bash
+
+        - name: Upload the DO worker
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
+
+        - id: upload_server
+          name: Upload server to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+        - name: Extract server version worker ID
+          shell: bash
+          id: extract_server_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_server.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Run updateWrangler scripts
+          shell: bash
+          run: |
+              bun run ./packages/gitbook/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
+
+        - id: upload_middleware
+          name: Upload middleware to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.43.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+
+        - name: Extract middleware version worker ID
+          shell: bash
+          id: extract_middleware_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_middleware.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Deploy server and middleware to Cloudflare
+          if: ${{ inputs.deploy == 'true' }}
+          uses: ./.github/actions/gradual-deploy-cloudflare
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              opServiceAccount: ${{ inputs.opServiceAccount }}
+              opItem: ${{ inputs.opItem }}
+              environment: ${{ inputs.environment }}
+              serverVersionId: ${{ steps.extract_server_version_id.outputs.version_id }}
+              middlewareVersionId: ${{ steps.extract_middleware_version_id.outputs.version_id }}
+              deploy: ${{ inputs.deploy }}
+
+        - name: Outputs
+          shell: bash
+          env:
+              DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
+          run: |
+              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
+              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"

.github/composite/deploy-vercel/action.yaml

@@ -0,0 +1,101 @@
+name: 'Deploy vercel'
+description: 'Deploy GitBook to Vercel'
+inputs:
+    vercelOrg:
+        description: 'Vercel organization'
+        required: true
+    vercelProject:
+        description: 'Vercel project'
+        required: true
+    vercelToken:
+        description: 'Vercel token'
+        required: true
+    opItem:
+        description: '1Password item to load secrets from'
+        required: true
+    opServiceAccount:
+        description: '1Password service account token'
+        required: true
+    environment:
+        description: 'Environment to deploy to'
+        required: true
+    headSha:
+        description: 'Git ref to deploy, used for the deploymentId'
+        required: false
+outputs:
+    deployment-url:
+        description: 'Deployment URL'
+        value: ${{ steps.deploy.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup Bun
+          uses: ./.github/composite/setup-bun
+        - name: Install dependencies
+          run: bun install --frozen-lockfile
+          shell: bash
+          env:
+              PUPPETEER_SKIP_DOWNLOAD: 1
+        - name: Pull Vercel Environment Information
+          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+              OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+              GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+              GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+              GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+              GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+              GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+              GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+              GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+              GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+              GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
+              GITBOOK_SITE_OAUTH_SIGNING_SECRET: ${{ inputs.opItem }}/GITBOOK_SITE_OAUTH_SIGNING_SECRET
+              GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
+              GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
+              GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
+              GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
+              GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL_2
+              GITBOOK_IMAGE_RESIZE_SALT: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SALT
+              GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
+              GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+              GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
+        - name: Inject build env vars
+          if: ${{ inputs.environment == 'preview' }}
+          shell: bash
+          run: |
+              HEAD_SHA=$(git rev-parse HEAD)
+              echo "resolved HEAD_SHA: $HEAD_SHA"
+              echo "GITBOOK_HEAD_SHA=$HEAD_SHA" >> .vercel/.env.${{ inputs.environment }}.local
+              echo "GITBOOK_RUNTIME=vercel" >> .vercel/.env.${{ inputs.environment }}.local
+              echo "GITBOOK_BLOCK_SEARCH_INDEXATION=true" >> .vercel/.env.${{ inputs.environment }}.local
+              echo "GITBOOK_ALLOW_CUSTOMIZATION_OVERRIDE=true" >> .vercel/.env.${{ inputs.environment }}.local
+              echo "GITBOOK_DISABLE_INSIGHTS=true" >> .vercel/.env.${{ inputs.environment }}.local
+              echo "--- .vercel/.env.${{ inputs.environment }}.local after inject ---"
+              cat .vercel/.env.${{ inputs.environment }}.local
+        - name: Build Project Artifacts
+          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+              GITBOOK_RUNTIME: vercel
+              GITBOOK_HEAD_SHA: ${{ inputs.headSha }}
+        - name: Deploy Project Artifacts to Vercel
+          id: deploy
+          shell: bash
+          run: |
+              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
+              echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
+          env:
+              VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+              VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Outputs
+          shell: bash
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/composite/setup-bun/action.yaml

@@ -0,0 +1,9 @@
+name: 'Setup Bun'
+description: 'Install Bun and cache dependencies'
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup bun
+          uses: oven-sh/setup-bun@v2
+          with:
+              bun-version-file: 'package.json'

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Proposed changes
+
+<!-- Briefly describe what changed. Include relevant validation. -->
+
+## Demo
+
+<!-- Add screenshots or a recording when useful. Otherwise, remove this section. -->
+
+<!-- Optional: add Context here only when it explains a concrete problem and result that the changelog does not. Remove this comment before submitting. -->
+
+## Changelog
+
+<!-- Keep the relevant entries and remove unused placeholders. Feature = user-facing addition or improvement; Fix = user-facing bug fix; Chore = internal maintenance. -->
+
+- [Feature] ...
+- [Fix] ...
+- [Chore] ...

.github/slack-pr-status-app-manifest.json

@@ -0,0 +1,22 @@
+{
+    "display_information": {
+        "name": "PR Status",
+        "description": "Updates PR status reactions in engineering"
+    },
+    "features": {
+        "bot_user": {
+            "display_name": "PR Status",
+            "always_online": false
+        }
+    },
+    "oauth_config": {
+        "scopes": {
+            "bot": ["channels:history", "reactions:read", "reactions:write"]
+        }
+    },
+    "settings": {
+        "org_deploy_enabled": false,
+        "socket_mode_enabled": false,
+        "token_rotation_enabled": false
+    }
+}

.github/slack-pr-status.md

@@ -0,0 +1,15 @@
+# Slack PR status
+
+[GitbookIO/slack-pr-status](https://github.com/GitbookIO/slack-pr-status) adds review-status reactions to PR links posted in [#engineering](https://gitbook.slack.com/archives/C01NXGWJELS). It runs from `.github/workflows/slack-pr-status.yml` in `GitbookIO/gitbook`, `GitbookIO/gitbook-x` and `GitbookIO/integrations`. Emojis and statuses are configured in that workflow; see the action's README for the options.
+
+Owner: Peter White.
+
+| Configuration | Value |
+| --- | --- |
+| Slack app | **PR Status** (`A0C2AGLAD0T`), created from `.github/slack-pr-status-app-manifest.json` |
+| Bot token | Repository Actions secret `SLAPR_SLACK_BOT_TOKEN` |
+| GitHub token | The workflow's `GITHUB_TOKEN`, read-only |
+
+Posts that link PRs from more than one repository are skipped, because each workflow's token can only read its own repository. PRs from forks get no reactions, because their workflows don't receive secrets.
+
+To disable it in one repository, run `gh workflow disable slack-pr-status.yml --repo GitbookIO/<repository>`. To stop it everywhere, revoke the PR Status app's token.

.github/workflows/ci.yaml

@@ -0,0 +1,78 @@
+name: CI
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+            - changeset-release/main
+jobs:
+    format:
+        runs-on: ubuntu-latest
+        name: Format
+        timeout-minutes: 6
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - run: bun format:check
+    lint:
+        runs-on: ubuntu-latest
+        name: Lint
+        timeout-minutes: 6
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - run: bun lint
+    test:
+        runs-on: ubuntu-latest
+        name: Test
+        timeout-minutes: 6
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - run: bun unit
+    build:
+        runs-on: ubuntu-latest
+        name: Build
+        timeout-minutes: 6
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - run: bun run build
+    typecheck:
+        runs-on: ubuntu-latest
+        name: Typecheck
+        timeout-minutes: 6
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - run: bun typecheck

.github/workflows/css-browser-compatibility.yaml

@@ -0,0 +1,34 @@
+name: CSS browser compatibility
+
+on:
+    pull_request_target:
+        types: [opened, reopened, synchronize]
+
+permissions:
+    contents: read
+    pull-requests: read
+
+concurrency:
+    group: css-browser-compatibility-${{ github.event.pull_request.number }}
+    cancel-in-progress: true
+
+jobs:
+    check:
+        name: Check newly added CSS declarations
+        runs-on: ubuntu-latest
+        timeout-minutes: 6
+        steps:
+            # pull_request_target checks out the trusted base branch by default. Never use the PR ref here.
+            - name: Checkout trusted checker
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Check CSS browser compatibility
+              working-directory: packages/gitbook
+              run: bun run check:css-browser-compatibility
+              env:
+                  GITHUB_TOKEN: ${{ github.token }}

.github/workflows/deploy-preview.yaml

@@ -0,0 +1,300 @@
+name: Preview
+on:
+    pull_request_target:
+    push:
+        branches:
+            - main
+jobs:
+    approval:
+        # Ensure that external contributors' PRs are manually approved before deployment
+        name: Approve Preview Deployment
+        runs-on: ubuntu-latest
+        if: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork }}
+        environment:
+            name: preview-approval
+        steps:
+            - name: Approval gate
+              run: echo "Preview deployment approved."
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (preview)
+        runs-on: ubuntu-latest
+        needs: approval
+        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
+        environment:
+            name: 2v-preview
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Deploy to Vercel
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: preview
+                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                  opItem: op://gitbook-open/2v-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  headSha: ${{ github.event.pull_request.head.sha || github.sha }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (preview)
+        runs-on: ubuntu-latest
+        needs: approval
+        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
+        environment:
+            name: 2c-preview
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Deploy to Cloudflare
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: preview
+                  deploy: ${{ github.ref == 'refs/heads/main' }}
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+                  commitMessage: ${{ github.sha }}
+            - name: Extract Worker ID
+              id: extract-worker-id
+              if: ${{ !steps.deploy.outputs.deployment-url }}
+              run: |
+                  if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
+                    WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
+                    echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
+                  fi
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}"
+    comment-deployments:
+        runs-on: ubuntu-latest
+        name: Comment Deployments (preview)
+        if: always() && github.event_name != 'push'
+        needs:
+            - deploy-v2-vercel
+            - deploy-v2-cloudflare
+        steps:
+            - name: Find GitHub Comment
+              uses: peter-evans/find-comment@v3
+              id: fc
+              with:
+                  issue-number: ${{ github.event.pull_request.number }}
+                  comment-author: 'github-actions[bot]'
+                  body-includes: 'Summary of the deployments'
+
+            - name: Create or update GitHub comment
+              uses: peter-evans/create-or-update-comment@v4
+              with:
+                  comment-id: ${{ steps.fc.outputs.comment-id }}
+                  issue-number: ${{ github.event.pull_request.number }}
+                  body: |
+                      Summary of the deployments:
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
+                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
+
+                      ### Test content
+
+                      | Site | `2v` | `2c` |
+                      | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
+                      | E2E | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                  edit-mode: replace
+    visual-testing-v2-vercel:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2
+        needs: deploy-v2-vercel
+        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
+        timeout-minutes: 15
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: v2-vercel
+    visual-testing-v2-cloudflare:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2 (Cloudflare)
+        needs: deploy-v2-cloudflare
+        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
+        timeout-minutes: 15
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: v2-cloudflare
+    visual-testing-customers-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2
+        needs: deploy-v2-vercel
+        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
+        timeout-minutes: 30
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: customers-v2-vercel
+
+            # Style recalc depends on the client bundle, not the host, so this runs here only and
+            # not in the Cloudflare job. Kept out of `e2e-customers`, which is a visual suite.
+            - name: Run style invalidation tests
+              if: always()
+              working-directory: packages/gitbook
+              run: bun run e2e-style-perf
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+
+            # Runs on failure too: a blown style budget is exactly when the numbers are worth seeing.
+            - name: Build style invalidation report
+              if: always() && github.event_name != 'push'
+              id: style-perf
+              working-directory: packages/gitbook
+              run: |
+                  rows=$(cat test-results/style-perf.md 2>/dev/null || true)
+                  if [ -z "$rows" ]; then exit 0; fi
+                  {
+                    echo 'body<<STYLE_PERF_EOF'
+                    echo '### Style invalidation on a large API reference'
+                    echo
+                    echo 'Elements restyled by opening one popup on [the Snyk API reference](https://docs.snyk.io/snyk-api/reference/apps). A share near or above 100% means the insertion restyles the whole document.'
+                    echo
+                    echo '| interaction | restyled | page | share | budget | |'
+                    echo '| --- | ---: | ---: | ---: | ---: | :-: |'
+                    echo "$rows"
+                    echo 'STYLE_PERF_EOF'
+                  } >> "$GITHUB_OUTPUT"
+
+            - name: Find style invalidation comment
+              if: always() && github.event_name != 'push' && steps.style-perf.outputs.body != ''
+              uses: peter-evans/find-comment@v3
+              id: fc-style-perf
+              with:
+                  issue-number: ${{ github.event.pull_request.number }}
+                  comment-author: 'github-actions[bot]'
+                  body-includes: 'Style invalidation on a large API reference'
+
+            - name: Create or update style invalidation comment
+              if: always() && github.event_name != 'push' && steps.style-perf.outputs.body != ''
+              uses: peter-evans/create-or-update-comment@v4
+              with:
+                  comment-id: ${{ steps.fc-style-perf.outputs.comment-id }}
+                  issue-number: ${{ github.event.pull_request.number }}
+                  body: ${{ steps.style-perf.outputs.body }}
+                  edit-mode: replace
+    visual-testing-customers-v2-cloudflare:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2 (Cloudflare)
+        needs: deploy-v2-cloudflare
+        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
+        timeout-minutes: 30
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: customers-v2-cloudflare
+    browserless-testing-v2-vercel:
+        runs-on: ubuntu-latest
+        name: Browserless Testing v2 (Vercel)
+        needs: deploy-v2-vercel
+        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run tests
+              run: cd ./packages/gitbook && bun e2e-browserless
+              env:
+                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+    # browserless-testing-v2-cloudflare:
+    #     runs-on: ubuntu-latest
+    #     name: Browserless Testing v2 (Cloudflare)
+    #     needs: deploy-v2-cloudflare
+    #     steps:
+    #         - name: Checkout
+    #           uses: actions/checkout@v4
+    #         - name: Setup Bun
+    #           uses: ./.github/composite/setup-bun
+    #         - name: Install dependencies
+    #           run: bun install --frozen-lockfile
+    #           env:
+    #               PUPPETEER_SKIP_DOWNLOAD: 1
+    #         - name: Run tests
+    #           run: cd ./packages/gitbook && bun e2e-browserless
+    #           env:
+    #               BASE_URL: ${{needs.deploy-v2-cloudflare.outputs.deployment-url}}
+    #               SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/

.github/workflows/deploy-production.yaml

@@ -0,0 +1,53 @@
+name: Production
+on:
+    push:
+        branches:
+            - main
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (production)
+        runs-on: ubuntu-latest
+        environment:
+            name: 2v-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: production
+                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                  opItem: op://gitbook-open/2v-production
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (production)
+        runs-on: ubuntu-latest
+        environment:
+            name: 2c-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: production
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-production
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -0,0 +1,53 @@
+name: Staging
+on:
+    push:
+        branches:
+            - main
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (staging)
+        runs-on: ubuntu-latest
+        environment:
+            name: 2v-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: staging
+                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                  opItem: op://gitbook-open/2v-staging
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (staging)
+        runs-on: ubuntu-latest
+        environment:
+            name: 2c-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: staging
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-staging
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/publish.yaml

@@ -0,0 +1,52 @@
+name: Publish
+
+on:
+    push:
+        branches:
+            - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+    publish:
+        name: Publish
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: write
+            pull-requests: write
+            contents: write
+        env:
+            # The repo is managed by Bun, but publishing uses npm for provenance.
+            # Keep Corepack from rejecting packageManager: bun@... when npm runs.
+            COREPACK_ENABLE_PROJECT_SPEC: 0
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v3
+              with:
+                  # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+                  fetch-depth: 0
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 22
+                  registry-url: 'https://registry.npmjs.org'
+            - name: Update npm
+              run: |
+                  corepack enable npm
+                  corepack install -g npm@latest
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Create Release Pull Request
+              id: changesets
+              uses: changesets/action@v1
+              with:
+                  publish: bun run publish-all-packages
+                  version: bun run changeset-version
+              env:
+                  # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
+                  # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
+                  GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}

.github/workflows/slack-pr-status.yml

@@ -0,0 +1,33 @@
+name: Slack PR status
+
+on:
+    pull_request_review:
+        types: [submitted, dismissed]
+    pull_request:
+        types: [closed, reopened]
+
+permissions:
+    contents: read
+    pull-requests: read
+
+jobs:
+    slack-pr-status:
+        # Secrets aren't available to workflows triggered from forks.
+        if: github.event.pull_request.head.repo.full_name == github.repository
+        runs-on: ubuntu-latest
+        steps:
+            - uses: GitbookIO/slack-pr-status@main
+              with:
+                  slack-token: ${{ secrets.SLAPR_SLACK_BOT_TOKEN }}
+                  config: |
+                      channels: [C01NXGWJELS]
+                      approvalsRequired: 1
+                      multiPr: aggregate
+                      emojis:
+                          commented: false
+                          partiallyApproved: next_track_button
+                          approved: pr-approved
+                          changesRequested: construction
+                          merged: merged
+                          closed: no_entry_sign
+                          partiallyReviewed: hourglass_flowing_sand

.gitignore

@@ -1,38 +1,34 @@
-# Logs
-logs
-*.log
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Deployed apps should consider commenting this line out:
-# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
+# dependencies
 node_modules
+/.pnp
+.pnp.js
 
-# vim swapfile
-*.swp
+# misc
+.DS_Store
+*.pem
 
-# GitBook with babel
-/packages/gitbook-core/lib
-/packages/gitbook-plugin/lib
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
-# Output of documentation
-_book
-book.pdf
-book.epub
-book.mobi
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Env files
+.env.local
+
+# TypeScript
+*.tsbuildinfo
+.npmrc
+
+# Bun pack artifacts
+packages/*/*.tgz
+
+# Playwright MCP artifacts
+.playwright-mcp/

.nvmrc

@@ -0,0 +1 @@
+v22.3

.oxfmtrc.json

@@ -0,0 +1,70 @@
+{
+    "$schema": "./node_modules/oxfmt/configuration_schema.json",
+    "printWidth": 100,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "jsxSingleQuote": false,
+    "quoteProps": "as-needed",
+    "trailingComma": "es5",
+    "bracketSpacing": true,
+    "bracketSameLine": false,
+    "arrowParens": "always",
+    "endOfLine": "lf",
+    "sortImports": {
+        "customGroups": [
+            {
+                "groupName": "workspace",
+                "elementNamePattern": ["@gitbook/**"]
+            }
+        ],
+        "groups": [
+            ["value-builtin", "value-external", "type-builtin", "type-external"],
+            { "newlinesBetween": true },
+            "workspace",
+            { "newlinesBetween": true },
+            [
+                "value-internal",
+                "type-internal",
+                "value-parent",
+                "type-parent",
+                "value-sibling",
+                "type-sibling",
+                "value-index",
+                "type-index"
+            ],
+            "type-import",
+            "unknown"
+        ]
+    },
+    "sortPackageJson": false,
+    "sortTailwindcss": {
+        "config": "./packages/gitbook/tailwind.config.ts",
+        "attributes": ["class", "className", "style"],
+        "functions": ["clsx", "tw"]
+    },
+    "ignorePatterns": [
+        "**/node_modules/**",
+        "**/dist/**",
+        "**/build/**",
+        "**/public/**",
+        "**/.next/**",
+        "**/.open-next/**",
+        "**/.turbo/**",
+        "**/.vercel/**",
+        "**/.cache/**",
+        "**/.wrangler/**",
+        "**/*.log",
+        "**/*.MD",
+        "**/*.md",
+        "**/*.mdx",
+        "**/*.html",
+        "**/*.css",
+        "packages/embed/standalone/**",
+        "packages/openapi-parser/src/fixtures/**",
+        "packages/emoji-codepoints/index.ts",
+        "packages/icons/src/data/*.json",
+        "packages/gitbook/worker-configuration.d.ts"
+    ]
+}

.oxlintrc.json

@@ -0,0 +1,87 @@
+{
+    "$schema": "./node_modules/oxlint/configuration_schema.json",
+    "categories": {
+        "correctness": "warn",
+        "suspicious": "warn",
+        "perf": "warn"
+    },
+    "plugins": ["eslint", "typescript", "unicorn", "oxc", "react", "jsx-a11y", "vitest"],
+    "env": {
+        "builtin": true,
+        "browser": true,
+        "node": true,
+        "shared-node-browser": true,
+        "worker": true
+    },
+    "globals": {
+        "Bun": "readonly",
+        "GitBookIntegrationEvent": "readonly",
+        "React": "readonly"
+    },
+    "rules": {
+        "eslint/no-console": [
+            "warn",
+            {
+                "allow": ["assert", "error", "warn"]
+            }
+        ],
+        "eslint/no-control-regex": "warn",
+        "eslint/no-prototype-builtins": "warn",
+        "eslint/no-cond-assign": "warn",
+        "eslint/no-undef": "error",
+        "eslint/no-unused-vars": [
+            "error",
+            {
+                "argsIgnorePattern": "^_",
+                "caughtErrorsIgnorePattern": "^_",
+                "ignoreRestSiblings": true,
+                "varsIgnorePattern": "^_"
+            }
+        ],
+        "react/button-has-type": "warn",
+        "react/exhaustive-deps": "warn",
+        "react/jsx-key": "warn",
+        "react/jsx-no-useless-fragment": "warn",
+        "react/no-array-index-key": "warn",
+        "react/void-dom-elements-no-children": "warn",
+        "react/rules-of-hooks": "error",
+        "jsx-a11y/alt-text": "warn",
+        "jsx-a11y/anchor-is-valid": "warn",
+        "jsx-a11y/click-events-have-key-events": "warn",
+        "jsx-a11y/iframe-has-title": "warn",
+        "jsx-a11y/interactive-supports-focus": "warn",
+        "jsx-a11y/label-has-associated-control": "warn",
+        "jsx-a11y/no-noninteractive-tabindex": "warn",
+        "jsx-a11y/role-has-required-aria-props": "warn",
+        "jsx-a11y/tabindex-no-positive": "warn",
+        "typescript/array-type": "error",
+        "typescript/no-explicit-any": "warn",
+        "typescript/no-non-null-assertion": "warn",
+        "typescript/no-confusing-void-expression": "warn",
+        "typescript/only-throw-error": "error",
+        "vitest/no-focused-tests": "error",
+        "no-delete-var": "warn",
+        "no-debugger": "error",
+        "no-throw-literal": "error",
+        "use-isnan": "error",
+        "valid-typeof": "error"
+    },
+    "ignorePatterns": [
+        "**/node_modules/**",
+        "**/dist/**",
+        "**/build/**",
+        "**/public/**",
+        "**/.next/**",
+        "**/.open-next/**",
+        "**/.turbo/**",
+        "**/.vercel/**",
+        "**/.cache/**",
+        "**/.wrangler/**",
+        "packages/embed/standalone/**",
+        "packages/openapi-parser/src/fixtures/**",
+        "packages/emoji-codepoints/index.ts",
+        "packages/icons/src/data/*.json",
+        "packages/gitbook/worker-configuration.d.ts",
+        "**/*.css"
+    ]
+}

.travis.yml

@@ -1,14 +0,0 @@
-sudo: false
-language: node_js
-os:
-  - linux
-  - osx
-node_js:
-  - "stable"
-  - "4.1"
-before_install:
-  - npm install svgexport -g
-before_script:
-  - npm run bootstrap
-after_success:
-  - npm run lint

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["oxc.oxc-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+    "tailwindCSS.experimental.classRegex": [
+        ["Style \\=([^;]*);", "'([^']*)'"],
+        ["Style \\=([^;]*);", "\"([^\"]*)\""],
+        ["Style \\=([^;]*);", "\\`([^\\`]*)\\`"],
+        ["style \\=([^;]*);", "'([^']*)'"],
+        ["style \\=([^;]*);", "\"([^\"]*)\""],
+        ["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
+    ],
+    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "oxc.oxc-vscode",
+    "editor.codeActionsOnSave": {
+        "source.fixAll.oxc": "always"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "oxc.oxc-vscode"
+    }
+}

AGENTS.md

@@ -0,0 +1,82 @@
+# AGENTS Instructions
+
+## Commands
+
+```bash
+bun install          # Install dependencies
+bun dev              # Start dev server (all packages)
+bun run build        # Build all packages
+bun run lint         # Lint with Oxlint
+bun run format       # Format with Oxfmt (run after every change)
+bun run typecheck    # Type-check all packages
+bun run unit         # Run unit tests
+```
+
+## Development
+
+The dev server proxies published GitBook sites locally. After `bun dev`, access any published site at:
+
+```
+http://localhost:3000/url/<published-gitbook-url>
+```
+
+Examples:
+- `http://localhost:3000/url/gitbook.com/docs`
+- `http://localhost:3000/url/open-source.gitbook.io/midjourney`
+
+## Architecture
+
+```
+packages/
+  gitbook/          # Main Next.js app
+    src/
+      app/          # Next.js App Router (sites/)
+      components/   # React components
+      lib/          # Server utilities, data fetching
+      intl/         # Internationalization (translations/)
+  openapi-parser/   # OpenAPI 3.0/3.1/Swagger parser
+  react-openapi/    # OpenAPI rendering components
+  react-contentkit/ # ContentKit component rendering
+  embed/            # Embeddable GitBook components
+  shared/           # Shared utilities
+  icons/            # Icon assets
+  fonts/            # Font assets
+  colors/           # Color tokens
+  expr/             # GitBook expression evaluator
+  cache-do/         # Cloudflare DO cache
+  cache-tags/       # Cache tag utilities
+```
+
+## Testing
+
+```bash
+bun run unit         # Unit tests via bun test (not vitest)
+bun run e2e          # Playwright e2e tests (requires built app)
+```
+
+Run a specific test file:
+```bash
+cd packages/gitbook && bun test src/lib/cache.test.ts
+```
+
+## Changesets
+
+After committing code changes, create a changeset for the affected package:
+
+```md
+---
+"gitbook": patch
+---
+
+Provide a short description of the change.
+```
+
+Save as `.changeset/<name>.md`, then commit it separately with message: `changeset`
+
+## Formatting
+
+Linting uses Oxlint and formatting uses Oxfmt. Always run `bun run format` before committing.
+
+## Comments
+
+Comment to explain *why*, not *what* — the code already shows what it does. Keep comments short, ideally a single line. Avoid multi-line block comments that narrate mechanics a reader can follow from the code; they add noise and go stale. Reserve longer comments for genuinely non-obvious rationale: a subtle invariant, or a workaround and the reason it exists.

AUTHORS.md

@@ -1,68 +0,0 @@
-Authors
-=======
-
-Also see https://github.com/GitbookIO/gitbook/graphs/contributors.
-Names below are ordered by first contribution.
-
-Author
-------
-
-- Samy Pessé <samy@gitbook.com> (@SamyPesse)
-- Aaron O'Mullan <aaron@gitbook.com> (@AaronO)
-- Johan Preynat <johan@gitbook.com> (@jpreynat)
-- Nicolas Gaborit <nicolas@gitbook.com> (@soreine)
-
-Contributors
-------------
-
-- Nijiko Yonskai (@Nijikokun)
-- Herman Starikov (@Hermanya)
-
-Translators
-------------
-
-- German
-    - Winnie (@winniehell)
-- Italian
-    - Giulio Bonanome (@gbonanome)
-- Russian
-    - Andrey Akinshin (@AndreyAkinshin)
-- Norwegian
-    - Knut Melvær (@kmelve)
-- Persian (Farsi)
-    - Mohammad Hossein Mojtahedi (@mhm5000)
-- Polish
-    - Łukasz Szeremeta (@lszeremeta)
-- Portuguese
-    - Ryan O'Mullan (@RyanOM)
-- Spanish
-    - Ryan O'Mullan (@RyanOM)
-- Simplifiled Chinese
-    - Hu Hao (@howiehu)
-- Traditional Chinese
-    - Hu Hao (@howiehu)
-- French
-    - Samy Pessé (@SamyPesse)
-- Romanian
-        - Iancu Aurel (@awrelll)
-- Finnish
-    - Tommi Savikko (@savikko)
-- Japanese
-    - Iancu Aurel (@awrelll)
-- Korean
-    - Iancu Aurel (@awrelll)
-    - SangYeob Yu (@deminoth)
-- Vietnamese
-    - Hong Nguyen (@nghong)
-- Hebrew
-    - @a-moses
-- Ukrainian
-    - @Karnaukhov
-- Czech
-    - @mjanda
-- Swedish
-    - Jacob Burenstam (@buren)
-- Turkish
-    - Turan Konan (@turankonan)
-- Catalan
-    - Esaú García Sánchez-Torija (@egasato)

CHANGES.md

@@ -1,399 +0,0 @@
-# Release notes
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-
-## 4.0.0
-- **Breaking Changes:** Most plugins and themes should be incompatible with this version
-- GitBook rendering is now done using React, which brings better APIs for plugins and a more interactive website.
-- *Performances*: Installation of plugins is much faster thanks to `ied`
-- *Performances*: Git conrefs are faster over large books
-- *Website Feature:* new default plugin `copy-code` to copy code blocks content in one click
-- *Website Feature:* new default plugin `heading-anchors` to have clickable headings
-- *Website Feature:* `fontsettings` is now only controlling the font size, and can work on multiple themes
-- *Plugin API*: hook `page` can no longer modify the content, only the page's attributes
-- *Plugin API*: plugins can no longer export resources, instead use the `_assets` folder
-- [ ] *Plugin API*: testing framework
-- [ ] `gitbook init` creates `.gitignore` if not found
-- [ ] Ignore files are no longer copied to the output
-
-## 3.2.2
-- Fix catching parsing errors leading to possible missing pages in generated book
-- Rollback markdown parser to `kramed` until `markup-it` is stable enough
-
-## 3.2.1
-- Fix bug on Firefox when navigating to an url containing an hash
-- Update nunjucks to fix JS error when page contains a lot of templating blocks
-
-## 3.2.0
-- Switch markdown parser from `kramed` to `markup-it`
-- Fix support of `|` in tables
-- Fix access to `output.name` in templating
-- Fix i18n for website and PDF
-- Fix minor scrolling issues on website
-- Improve options of default search indexer (keywords, disabling per pages)
-- Improve pertinence of search results
-
-## 3.1.1
-- Fix order of plugins during loading
-- Fix error when using math and conrefs
-- Fix target attribute for external links
-- Fix serve command
-
-## 3.1.0
-- Always load themes after plugins
-- README/Introduction doesn't require to be the first entry in the summary
-- Highlight active entry in summary when scrolling a page with anchors
-- Support empty parts in summary
-
-## 3.0.3
-- Fix redirection in `gitbook serve` when accessing a folder without trailing slash
-- Fix links/annotations for glossary not being correctly resolved
-- Fix regression for supporting uppercase filenames in structure files
-- Fix `gitbook install` when using Git URLs for plugins
-
-## 3.0.2
-- Fix crash for anchor links
-
-## 3.0.1
-- Fix regression in link resolution when contain anchor
-- Fix `structure.<name>` configuration not supporting filenames with dots
-
-## 3.0.0
-- Summary can contain external links and anchors (Fix [#776](https://github.com/GitbookIO/gitbook/issues/776))
-- Summary can contain differents entitled sections
-- Glossary is generated as a normal page
-- Headings are no longer annotated with glossary terms
-- Themes are now published as a plugin, with ability to extend it from the book source
-- `links.sidebar` configuration is no longer supported, use summary sections instead
-- `pdf.headerTemplate` and `pdf.footerTemplate` have been replaced by a template in theme/book: `_layout/ebook/pdf_header.html` and `_layout/ebook/pdf_footer.html`
-- Markdown parser is now using CommonMark
-- Root folder for the book can be specified in the `"root"` property of the `book.json` file
-- Multi-lingual books share assets folder
-- YAML front matter is parsed and can extend page's properties
-- Fix `uk` translation
-- Fix heading ID including dashes
-- Fix error in code highlighting for unknown languages
-- Fix data-uri images being handled as external images
-- Accept SSH url as plugin version
-- Add templating blocks `markdown`, `asciidoc` and `markup`
-- Better search experience
-- Better default theme, more responsive and cleaner
-
-## 2.6.7
-- Fix bug with filenames including spaces
-- Add Turkish and Catalan translations
-
-## 2.6.6
-- Fix custom CSS that are generated by plugins for PDF output
-
-## 2.6.5
-- Fix support for plugins generating custom stylesheets (`styles-less` and `styles-sass`)
-- Fix glossary terms being replaced in script (ex: math)
-
-## 2.6.4
-- Fix regression introduced by `2.6.3` of single HTML tags in markdown
-
-## 2.6.3
-- Fix parsing bug with inline HTML in Markdown
-
-## 2.6.2
-- Fix `gitbook.state.bookRoot`, `gitbook.state.root` now has a trailing slash
-- Update nunjucks to 2.2.0
-
-## 2.6.1
-- Use CamelCase for `gitbook.state.innerLanguage`
-
-## 2.6.0
-- Close sidebar after clicking a link on mobile
-- Add root for multilingual books: `gitbook.state.bookRoot`
-- Fix color of h6 headings
-- Fix bottom margin of lists and blockquotes
-- Add Swedish translation (`sv`)
-- Add Czech translation (`cs`)
-- Fix locale names for `zh-hans` and `jp`
-- Update plugin `search` to fix crashes
-- Aceept case-incensitive structure files (README, GLOSSARY, etc)
-
-## 2.5.2
-- Fix custom stylesheets for ebook generation
-- Trigger event `start` before `page.change`
-
-## 2.5.1
-- Fix calcul of `gitbook.state.root` when serving HTML index as `/`
-
-## 2.5.0
-- Font settings, sharing and search are externalized as default plugins
-- Plugins can define a configuration schema in the manifest, this schema will be used to validate configuration during build
-- New Node.js API for plugin: `book.formatString(type, content)`
-- New client side API for website plugins: `gitbook.toolbar.createButton(opts)`
-- Better header/footer for PDF, CSS wil be inlined to easily style the header/footer
-- Cleaner table of contents for ebooks
-- Support for RTL in ebook's table of contents
-- Better colors for mobi (links and code blocks)
-- Fix installation of plugins when using a pre-release
-- Fix support for pre-releases
-- Update asciidoc parser to remove git dependency
-- Fix templating in imported content
-- Fix querystring in image urls
-- Normalize heading IDs like GitHub
-- Use Arial as default font for PDFs
-- Add `root`, `chapterTitle` and `filepath` to `gitbook.state` JS API
-
-## 2.4.3
-- Add ukrainian translation (`uk`)
-- Add `book.json` configuration for maximum size of search index
-- Improve reliability of summary parser
-
-## 2.4.2
-- Default plugins should not be installed by `gitbook install`
-- Limit search index size to avoid crash during generation
-- Fix code highlighting for html without language specified
-- Fix warning message for gitbook version when building a multilingual book
-
-## 2.4.1
-- Fix disabling of default plugins, ex: `-highlight`
-
-## 2.4.0
-- Fix page being updated when user wants to open a link in a new tab
-- Plugins can now replaced default code highlighter
-- Add semantic information for screen readers (web version)
-- Content references accept absolute paths, resolved to book folder
-- Improve overall reliability
-
-## 2.3.3
-- Fix bug in SUMMARY parsing preventing multiple entries without filenames
-
-## 2.3.2
-- Fix blocks (like maths) in Asciidoc
-- Fix error when checking gitbook version
-
-## 2.3.1
-- Fix black font color for ebooks (mobi, pdf and epub)
-- Fix ISO code for korean language
-- Fix korean translation
-- Fix syntax highlighting for asciidoc
-- Fix inline html escaping in markdown
-- Add warning for file outside SUMMARY
-- Force SUMMARY entries to be unique by filename
-
-## 2.3.0
-- Fix nunjucks issue with multiple `{% raw %}` blocks
-- Fix crash when git conref failed
-- Fix crash when failed to download remote image (better error message)
-- Fix flicking effect when changing page (big UX improvement)
-- Add Hebrew translation (`he`)
-- Add utility method `book.config.get` for plugins
-- Hooks `page:before` and `page` are no longer deprecated
-- Remove webfonts to make website lighter
-- Make glossary's order case insensitive
-
-## 2.2.0
-- Fix direction in code blocks (always LTR)
-- Add options `chapterMark` and `pageBreaksBefore` for PDF
-- Update code highlighting library
-- `book.json` accessible as `config` in templating syntax
-- Add Vietnamese translation (`vi`)
-
-## 2.1.0
-- Fix error in calcul of `levels` in table of contents, error introduced a few versions ago
-- Add optional `styles/print.css` to replace `print.css` used in ebook
-
-## 2.0.4
-- Fix `{% raw %}`, got confused with "fake" variable declarations
-- Fix title of language chooser
-- Fix the X-UA-Compatible meta tag
-- Move style sheets to the <head> section
-
-## 2.0.3
-- Fix `gitbook init` for SUMMARY with empty entries
-- Fix escaping of code blocks in markdown
-
-## 2.0.2
-- Fix relative links in windows
-- Improve watcher in serve command (switch to chokidar)
-- Add Romanian translation (`ro`)
-- Add Finish translation (`fi`)
-- Add Japanese translation (`jp`)
-- Add Korean translation (`kr`)
-
-## 2.0.1
-- Improve error logging (display file, line and column)
-- Add back support for `options.originalInput`
-- Don't process math in markdown parser (delegated to `mathjax` plugin)
-- Fix some cases of code blocks escaping
-- Fix i18n for introduction title in json format
-- Fix reload when book configuration is updated
-- Fix backslashes in url when building on windows
-
-## 2.0.0
-- Fix page title of introduction
-- Ignore codeblocks when replacing glossary terms
-- Improve Unit Tests
-- Fix scrolling position in website when preparing page
-
-## 2.0.0-beta.5
-- Fix progress order in json format
-
-## 2.0.0-beta.4
-- Fix default generator for use programmatically
-- Add option "author" for html meta tags
-- Fix links normalization (content and hash)
-
-## 2.0.0-beta.3
-- Fix odd cases with code blocks escaping
-
-## 2.0.0-beta.2
-- Fix definition of entry point title using SUMMARY.md
-
-## 2.0.0-beta.1
-- Fix windows incompatibility
-- Add support for rtl (enabled by default for `ar` and `fa`)
-- Escape code blocks in markdown parser
-- Add Persian/Farsi translation (`fa`)
-- Add Arabic translation (`ar`)
-- Add Bengali translation (`bn`)
-- Provide generator name in template context
-
-## 2.0.0-alpha.9
-- Fix links in sidebar
-- Fix normalization of html link (README to index)
-- Fix html snippets escaping
-
-## 2.0.0-alpha.8
-- Improve locale detection for i18n
-- Fix chapter name for Glossary in pdf
-- Don't escape html in glossary items
-- Fix generation of multilingual book as ebook
-- Add "post" block attribute to post-process
-
-## 2.0.0-alpha.7
-- Fix display of glossary in ebook formats
-- Add default footer and header to pdf
-- Fix generation of json format compatible with 1.x.x
-- Add Simplifiled Chinese and Traditional Chinese translations
-
-## 2.0.0-alpha.6
-- Add es and pt translations
-- Fix replacement of glossary terms
-
-## 2.0.0-alpha.5
-- Fix copy of files/covers
-- Add back `finish:before` hook
-
-## 2.0.0-alpha.4
-- Fix copy of cover for multilingal books
-
-## 2.0.0-alpha.3
-- Norwegian translation
-- Load plugins from book in priority
-
-## 2.0.0-alpha.3
-- Fix init command
-- Update parsers to fix spaces in summary (`gitbook-parsers@0.3.1`)
-
-## 2.0.0-alpha.1
-- Externalize parsing into `gitbook-parsers` module
-- Supports AsciiDoc and reStructuredText
-- Hooks for page (`page:*`) are now deprecated, plugins should extend filters and blocks instead
-- Hooks `summary` and `glossary` (after and before) have been removed
-- Exercises and Quizzes are no longer parsed in the markdown parser
-- Support for more markdown extensions: `.markdown`, `.mdown`
-- Templates are rendered with nunjucks instead of swig, syntax is almost compatible, there is some changes with contexts and filters. `{{ super() }}` should be use instead of `{% parent %}`
-- Clean output folder on build without removing `.git` and `.svn`
-- MathJAX is no longer a default plugin
-- SVG images are converted to PNG during generation of ebooks
-- i18n in website and ebook (ru, it, de, fr)
-- New templating syntax
-- Content references (both internal and external)
-- Glossary terms are handled during generation (also in ebook format)
-
-## 1.5.0
-- Fix `serve` command, broken by `1.4.2`
-- Add nicer `dark` theme :)
-
-## 1.4.2
-- Force `process.exit` after builds, to prevent (possibly) lingering plugins
-
-## 1.4.1
-- Fix command 'install' without arguments
-
-## 1.4.0
-- Add command `gitbook install` to install plugins from book.json
-- `package.json` is no longer necessary
-
-## 1.3.4
-- Add glossary to ebooks
-- Fix autocover with new hook "finish:before"
-- Add X-UA-Compatible meta tag for IE
-
-## 1.3.3
-- Fix parsing of lexed content using the client library
-
-## 1.3.2
-- ePub files are now passing validation from epubcheck
-- Fix replacement of multiple glossary terms in a single sentence
-- Fix on windows deep relative links
-- Fix search indexer
-
-## 1.3.1
-- Fix error with links in markdown
-
-## 1.3.0
-- Bundle gitbook parsing library as a client side library in `gitbook.js` and `gitbook.min.js`
-
-## 1.2.0
-- Improvements on ebook generation
-- Fix incorrect follow of links in ebook generation
-- Move Table of Contents at the beginning of the ebook
-- Update to last highlight.js (includes Swift)
-- Includes of templates and variables (from book.json)
-
-## 1.1.1
-- Rewrite quiz logic to be more robust
-- Improve integration of glossary
-- Improve generation of ebook by using a multiple HTML pages input source
-- Fix incorrect page breaks after h1 and h2 divs
-- New options to set header and footer in PDF generation
-
-## 1.1.0
-- Plugins can now extend the ebook generation (pdf, epub, mobi)
-- Update `kramed` to version 0.4.3
-
-## 1.0.3
-- Update `mathjax` plugin and MathJAx to version 2.4
-- Update `highlight.js` to 8.2.0
-
-## 1.0.2
-- Update `mathjax` plugin, fixes issues with inline math rendering (no longer wanted)
-
-## 1.0.1
-- New inline math convention (kramdown's), using `$$` rather than `$` as delimiters
-- Fix instapaper sharing
-- The `exercises` & `quizzes` plugins are now by default
-
-## 1.0.0
-- New design
-- Support for glossary
-- Support for sharing to instapaper
-- Support for footnotes
-
-## 0.7.1
-- Update `fs-extra` to `0.10.0` (fixes potential race conditions)
-
-## 0.7.0
-- Add page break in ebook (pdf, epub, mobi) between chapters/articles
-- Start using kramed instead of marked
-- Fix display of inline math
-- Switch to graceful-fs to fix EMFILE errors
-- Add sharing to weibo.com
-
-## 0.6.2
-- Support generating a plugin's book info dynamically
-- Improve navigation on dark theme
-- Improve path normalization when parsing SUMMARY.md
-
-## 0.6.0
-- Generate header id the same as github
-- Custom links can be added at top of sidebar
-- Summary can now be transformed by plugins
-- Support importing code snippets

CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

CONTRIBUTING.md

@@ -1,51 +0,0 @@
-
-# Contributing
-
-Want to contribute to GitBook? That would be awesome!
-
-- [Send feedback](#send-feedback)
-- [Reporting Bugs](#reporting-bugs)
-- [Asking Questions](#asking-questions)
-- [Submitting Pull Requests](#submitting-pull-requests)
-- [Running Tests](#running-tests)
-
-## Send feedback
-
-We’ve done our best to test but your feedback is really important. If you encounter problems or have feedback about GitBook products (GitBook.com, GitBook Editor, or the Toolchain), please log an issue in the [GitbookIO/feedback](https://github.com/GitbookIO/feedback/issues) repository.
-
-
-## Reporting Bugs
-
-If you run into any weird behavior while using GitBook, feel free to open a new issue in this repository! To be most helpful, please include the steps to reproduce the bug as best you can, including the output of command `gitbook -V`.
-
-## Asking Questions
-
-Questions are very welcome :smile:! Previous questions that folks have asked are tagged with a [`question`](https://github.com/GitBookIO/gitbook/issues?q=is%3Aissue+is%3Aclosed+label%3Aquestion) label, so before opening a new issue double-check that someone hasn't asked it before. But if you don't see anything, or if you're not sure if it's the same, err on the side of asking!
-
-We've also got a [GitBook Community Slack](https://slack.gitbook.com/) where you can ask questions and get answers from other people using GitBook.
-
-## Submitting Pull Requests
-
-All pull requests are super welcomed and greatly appreciated! Easy issues are marked with an [`easy-one`](https://github.com/GitBookIO/gitbook/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-one) label if you're looking for a simple place to get familiar with the code base.
-
-Please include tests and docs with every pull request!
-
-## Running Tests
-
-To run the examples, you need to have the GitBook repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm` using `yarn`.
-
-```
-$ yarn install
-```
-
-Then you'll need to bootstrap it:
-
-```
-$ npm run bootstrap
-```
-
-Which will also compile the source files. Then run the tests with:
-
-```
-$ npm test
-```

LICENSE

@@ -1,201 +1,674 @@
-Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
 
-   1. Definitions.
+                            Preamble
 
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
+The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
 
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
 
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
 
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
 
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
 
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
 
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
 
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
+The precise terms and conditions for copying, distribution and
+modification follow.
 
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
+                       TERMS AND CONDITIONS
 
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
+0. Definitions.
 
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
+"This License" refers to version 3 of the GNU General Public License.
 
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
+"Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
 
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
 
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
 
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
+A "covered work" means either the unmodified Program or a work based
+on the Program.
 
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
 
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
 
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
+An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
 
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
+1. Source Code.
 
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
+The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
 
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
 
-   END OF TERMS AND CONDITIONS
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
 
-   APPENDIX: How to apply the Apache License to your work.
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
 
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
+The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
 
-   Copyright 2014 FriendCode Inc.
+The Corresponding Source for a work in source code form is that
+same work.
 
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
+2. Basic Permissions.
 
-       http://www.apache.org/licenses/LICENSE-2.0
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+13. Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,59 +1,164 @@
-[![GitBook](https://raw.github.com/GitbookIO/gitbook/master/docs/images/banner.png)](https://www.gitbook.com)
-
-<p align="center">A <em>modern</em> customizable documentation format and toolchain</p>
-
-
-<p align="center"><a href="#features"><strong>Features</strong></a> · <a href="https://www.gitbook.com"><strong>Hosting</strong></a> · <a href="http://redux.js.org/"><strong>Example</strong></a> · <a href="https://www.gitbook.com/editor"><strong>Editor</strong></a> · <a href="https://toolchain.gitbook.com/"><strong>Documentation</strong></a> · <a href="./CONTRIBUTING.md"><strong>Contributing!</strong></a> · <a href="https://twitter.com/GitBookIO"><strong>Twitter</strong></a></p>
-<br/>
-
-![Preview](https://raw.github.com/GitbookIO/gitbook/master/docs/images/preview.png)
-
-
 <p align="center">
-<img src="https://badge.fury.io/js/gitbook.svg" />
-<a href="https://travis-ci.org/GitbookIO/gitbook"><img src="https://travis-ci.org/GitbookIO/gitbook.png?branch=master" /></a>
-<a href="https://ci.appveyor.com/project/GitBook/gitbook"><img src="https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true" /></a>
-<a href="https://ci.appveyor.com/project/GitBook/gitbook"><img src="https://slack.gitbook.com/badge.svg" /></a>
+  <img src="./assets/gitbook_icon_dark.svg" alt="GitBook" width="48" />
 </p>
 
-GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [ReduxJS documentation](http://redux.js.org/).
+<h1 align="center">GitBook</h1>
 
-You can publish and host books easily online using [gitbook.com](https://www.gitbook.com). A desktop editor is [also available](https://www.gitbook.com/editor).
+<p align="center">
+  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> - <a href="https://github.com/orgs/GitbookIO/discussions/categories/feature-requests">Feature requests</a> 
+</p>
 
-Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
+<p align="center">
+  <a href="https://gitbook.com"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="#"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
+  <a href="/LICENSE"><img src="https://img.shields.io/badge/License-GNU_GPLv3-F4E28D"/></a>
+  <a href="/.github/CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors/gitbookIO/gitbook"/></a>
+  <a href="https://github.com/gitbookIO/gitbook/issues"><img src="https://img.shields.io/github/issues/gitbookIO/gitbook"/></a>
+</p>
 
-Complete documentation is available at [toolchain.gitbook.com](http://toolchain.gitbook.com/).
+<p align="center">Welcome to GitBook, the platform for managing technical knowledge for teams.</p>
 
-## Getting started
+<p align="center">This repository contains the open source code used to render GitBook's published content.</p>
 
-GitBook can be used either on your computer for building local books or on GitBook.com for hosting them. To get started, check out [the installation instructions in the documentation](docs/setup.md).
+<p align="center">
+  <img alt="GitBook Open Published Site" src="./assets/published-site.png">
+</p>
 
-## Usage examples
+## Table of Contents
 
-GitBook can be used to create book, public documentation, enterprise manual, thesis, research papers, etc.
+-   [Getting Started](#getting-started)
+-   [Contributing](#contributing)
+    -   [Types of contributions](#types-of-contributions)
+-   [Licensing](#license)
+-   [Acknowledgements](#acknowledgements)
+-   [Legacy GitBook](#legacy-gitbook-deprecated)
 
-You can find a [list of real-world examples](docs/examples.md) in the documentation.
+## Getting Started
 
-## Help and Support
+To run a local version of this project, please follow these simple steps.
 
-We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
+### Prerequisites
 
-## Features
+- Node.js (Version: >= 22.3)
+    - Use nvm for easy Node management
+- [Bun](https://bun.sh/) (Version: >=1.2.15)
+  - We use a text-based lockfile which isn't supported below 1.2.15
 
-* Write using [Markdown](http://toolchain.gitbook.com/syntax/markdown.html) or [AsciiDoc](http://toolchain.gitbook.com/syntax/asciidoc.html)
-* Output as a website or [ebook (pdf, epub, mobi)](http://toolchain.gitbook.com/ebook.html)
-* [Multi-Languages](http://toolchain.gitbook.com/languages.html)
-* [Lexicon / Glossary](http://toolchain.gitbook.com/lexicon.html)
-* [Cover](http://toolchain.gitbook.com/ebook.html)
-* [Variables and Templating](http://toolchain.gitbook.com/templating/)
-* [Content References](http://toolchain.gitbook.com/templating/conrefs.html)
-* [Plugins](http://toolchain.gitbook.com/plugins/)
-* [Beautiful default theme](https://github.com/GitbookIO/theme-default)
+### Set up
 
-## Publish your book
+1. Clone the repo into a **public** GitHub repository. If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, acquire a [commercial license](https://www.gitbook.com/pricing).
 
-The platform [GitBook.com](https://www.gitbook.com/) is like an "Heroku for books": you can create a book on it (public, or private) and update it using **git push**.
+```
+git clone https://github.com/gitbookIO/gitbook.git
+```
 
-## Licensing
+2. Ensure you are using the project's version of `node`. Running `nvm use` will change your local version to the correct one.
 
-GitBook is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
+3. Install the project's dependencies through Bun.
+
+```
+bun install
+```
+
+4. Start your local development server.
+
+```
+bun dev
+```
+
+6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
+
+examples:
+
+-   http://localhost:3000/url/gitbook.com/docs
+-   http://localhost:3000/url/open-source.gitbook.io/midjourney
+
+Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
+
+### CI and testing
+
+All pull-requests will be tested against both visual and performances testing to prevent regressions.
+
+## Fonts and Icons
+
+GitBook Open uses fontawesome. For self-hosting and local development, for licensing reasons, only the icons from the free version should be used.
+
+## Contributing
+
+GitBook's rendering engine is fully open source and built on top of [Next.js](https://nextjs.org/). Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to learn how to report bugs and suggest changes.
+
+### Types of contributions
+
+We encourage you to contribute to GitBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.
+
+#### Translations
+
+The GitBook UI is rendered using a set of translation files found in [`packages/gitbook/src/intl/translations`](/packages/gitbook/src/intl/translations/). Spotted a wrong or missing translation? Open an issue and let us know.
+
+#### Bugs
+
+Encounter a bug? [Open an issue](https://github.com/GitbookIO/gitbook/issues/new/choose) with as much detail as you can. Clear reports help us fix things faster for everyone.
+
+## Deployment
+
+> [!WARNING]  
+> While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.
+>
+> _Looking for a specific feature in GitBook? Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to suggest it._
+>
+> Self-hosting this project puts the responsibility of maintaining and merging future updates on **you**. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.
+>
+> We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to share your ideas with us instead of creating your own version.
+
+This project allows you to self-host the rendering portion of your GitBook published content. Self-hosting has pros and cons.
+
+On the pro side, you can customize the look and feel of your content, and better embed your documentation in your application.
+
+On the con side, you become responsible for the reliability of your published site, and keeping the renderer up-to-date with the changes made to the GitBook platform.
+
+## License
+
+Distributed under the [GNU GPLv3 License](https://github.com/GitBookIO/gitbook/blob/main/LICENSE).
+
+If you plan to distribute the code, you must make the source code public to comply with the GNU GPLv3. To clone in a private repository, acquire a [commercial license](https://www.gitbook.com/pricing).
+
+See `LICENSE` for more information.
+
+## Badges
+
+<p align="left">
+  <a href="https://gitbook.com"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="https://gitbook.com"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=F4E28D"></a>
+  <a href="https://gitbook.com"><img src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=FDA599"></a>
+</p>
+
+```md
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)
+```
+
+```html
+<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
+    <img
+        src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
+    />
+</a>
+```
+
+## Acknowledgements
+
+GitBook wouldn't be possible without these projects:
+
+-   [Next.js](https://nextjs.org/)
+-   [Bun](https://bun.sh/)
+-   [Tailwind CSS](https://tailwindcss.com/)
+-   [Framer Motion](https://www.npmjs.com/package/framer-motion)
+
+## Contributors
+
+<a href="https://github.com/gitbookIO/gitbook/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=gitbookIO/gitbook" />
+</a>
+
+## Legacy GitBook (Deprecated)
+
+Our previous version of GitBook and it's CLI tool are now deprecated. You can still view the old repository and it's commits on this [branch](https://github.com/GitbookIO/gitbook/tree/legacy).

appveyor.yml

@@ -1,38 +0,0 @@
-# Fix line endings in Windows. (runs before repo cloning)
-init:
-  - git config --global core.autocrlf input
-
-# Test against these versions of Node.js.
-environment:
-  matrix:
-    - nodejs_version: "6"
-    - nodejs_version: "5"
-    - nodejs_version: "4"
-
-matrix:
-  fast_finish: true
-
-# Install scripts. (runs after repo cloning)
-install:
-  # Get the latest stable version of Node.js or io.js
-  - ps: Install-Product node $env:nodejs_version
-  - set CI=true
-  # install svgexport
-  - npm install svgexport -g
-  # install modules
-  - npm install
-
-# Post-install test scripts.
-test_script:
-  # Output useful info for debugging.
-  - node --version
-  - npm --version
-  # run tests
-  - npm test
-
-# Don't actually build.
-build: off
-
-# Clone only last commit
-shallow_clone: true
-clone_depth: 1

assets/gitbook_icon_dark.svg

@@ -0,0 +1,3 @@
+<svg width="65" height="65" viewBox="0 0 65 65" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M27.3963 34.2195C30.5255 36.0255 32.09 36.9285 33.8082 36.93C35.5265 36.9315 37.0926 36.0313 40.2249 34.2308L60.1913 22.7534C61.0927 22.2353 61.6484 21.2749 61.6484 20.2352C61.6484 19.1955 61.0927 18.2351 60.1913 17.717L40.2177 6.23554C37.0888 4.43695 35.5243 3.53766 33.8078 3.53833C32.0912 3.539 30.5275 4.43951 27.4 6.24053L10.2292 16.1286C10.102 16.2019 10.0383 16.2385 9.97905 16.2732C4.11368 19.7068 0.489862 25.9754 0.441408 32.7717C0.440918 32.8404 0.440918 32.9138 0.440918 33.0607C0.440918 33.2074 0.440918 33.2807 0.441407 33.3494C0.489754 40.138 4.10549 46.4008 9.96041 49.837C10.0196 49.8718 10.0831 49.9085 10.2101 49.9818L20.9658 56.1918C27.2331 59.8104 30.3668 61.6197 33.808 61.6208C37.2493 61.622 40.3842 59.8148 46.6539 56.2005L58.008 49.6551C61.1474 47.8454 62.7171 46.9405 63.579 45.4487C64.4409 43.957 64.4409 42.1451 64.4409 38.5215V31.5212C64.4409 30.5159 63.8965 29.5895 63.0182 29.1004C62.1683 28.627 61.1325 28.6341 60.2891 29.1189L37.0074 42.5019C35.4453 43.3998 34.6643 43.8487 33.8072 43.849C32.9501 43.8493 32.1688 43.4008 30.6062 42.5038L14.8487 33.4586C14.0593 33.0055 13.6647 32.7789 13.3477 32.738C12.625 32.6448 11.9301 33.0497 11.6548 33.7244C11.534 34.0203 11.5365 34.4753 11.5414 35.3855C11.545 36.0555 11.5468 36.3905 11.6094 36.6987C11.7496 37.3887 12.1127 38.0136 12.6428 38.4771C12.8795 38.6842 13.1696 38.8516 13.7499 39.1866L30.5974 48.9103C32.164 49.8145 32.9473 50.2666 33.8075 50.2668C34.6677 50.267 35.4512 49.8154 37.0184 48.912L57.6684 37.0085C58.2037 36.7 58.4713 36.5457 58.672 36.6616C58.8727 36.7776 58.8727 37.0865 58.8727 37.7044V40.8796C58.8727 41.7855 58.8727 42.2385 58.6572 42.6114C58.4417 42.9844 58.0493 43.2106 57.2644 43.663L40.2322 53.4811C37.0966 55.2885 35.5288 56.1923 33.8078 56.1915C32.0869 56.1907 30.5199 55.2855 27.386 53.4752L11.4509 44.2701C11.4003 44.2409 11.375 44.2262 11.3514 44.2125C8.0102 42.26 5.94856 38.6882 5.92922 34.8185C5.92909 34.7911 5.92909 34.7619 5.92909 34.7035V31.7889C5.92909 29.6526 7.06686 27.678 8.9151 26.6067C10.5483 25.66 12.5628 25.6582 14.1977 26.6018L27.3963 34.2195Z" fill="#181C1F"/>
+</svg>

book.js

@@ -1,20 +0,0 @@
-var pkg = require('./package.json');
-
-module.exports = {
-    // Documentation for GitBook is stored under "docs"
-    root: './docs',
-    title: 'GitBook Toolchain Documentation',
-
-    // Use the "official" theme
-    plugins: ['sitemap'],
-
-    variables: {
-        version: pkg.version
-    },
-
-    pluginsConfig: {
-        sitemap: {
-            hostname: 'https://toolchain.gitbook.com'
-        }
-    }
-};

docs/README.md

@@ -1,25 +0,0 @@
-# GitBook Toolchain Documentation
-
-This document aims to be a comprehensive guide to GitBook. It contains the full documentation for version **{{ book.version }}**. Help for GitBook.com specific questions can be found at [help.gitbook.com](https://help.gitbook.com).
-
-### What is GitBook?
-
-GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). This documentation has been generated using GitBook.
-
-GitBook can output your content as a website ([customizable](themes/README.md) and [extensibles](plugins/README.md)) or as an ebook (PDF, ePub or Mobi).
-
-[GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor).
-
-### Help and Support
-
-We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
-
-Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
-
-### FAQ
-
-Some questions are frequently asked. If you have a problem you should [check this out](faq.md) first.
-
-### Contribute to this documentation
-
-You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes.

docs/SUMMARY.md

@@ -1,56 +0,0 @@
-# Summary
-
-### Getting Started
-
-* [About this documentation](README.md)
-* [Installation and Setup](setup.md)
-
-### Your Content
-
-* [Directory structure](structure.md)
-* [Pages and Summary](pages.md)
-* [Configuration](config.md)
-* [Glossary](lexicon.md)
-* [Multi-Lingual](languages.md)
-* [Markdown](syntax/markdown.md)
-    * [Headings](syntax/markdown.md#headings)
-    * [Paragraphs](syntax/markdown.md#paragraphs)
-    * [Emphasis](syntax/markdown.md#emphasis)
-    * [Lists](syntax/markdown.md#lists)
-    * [Links](syntax/markdown.md#links)
-    * [Images](syntax/markdown.md#images)
-    * [Blockquotes](syntax/markdown.md#blockquotes)
-    * [Tables](syntax/markdown.md#tables)
-    * [Code](syntax/markdown.md#code)
-    * [HTML](syntax/markdown.md#html)
-    * [Footnotes](syntax/markdown.md#footnotes)
-* [AsciiDoc](syntax/asciidoc.md)
-* [eBook and PDF](ebook.md)
-
-### Customization
-
-* [Templating](templating/README.md)
-    * [Content References](templating/conrefs.md)
-    * [Variables](templating/variables.md)
-    * [Builtin](templating/builtin.md)
-* [Plugins](plugins/README.md)
-    * [Create a plugin](plugins/create.md)
-    * [Hooks](plugins/hooks.md)
-    * [Blocks](plugins/blocks.md)
-    * [Filters](plugins/filters.md)
-    * [API & Context](plugins/api.md)
-    * [Test your plugin](plugins/testing.md)
-* [Theming](themes/README.md)
-
-### Plugin Development
-
-* [Introduction](./api/README.md)
-* [Node](./api/node.md)
-* [Connect to the context](./api/connect.md)
-* [Components](./api/components.md)
-
---
-
-* [FAQ](faq.md)
-* [Examples](examples.md)
-* [Release notes](https://github.com/GitbookIO/gitbook/blob/master/CHANGES.md)

docs/api/README.md

@@ -1,24 +0,0 @@
-# Plugin Architecture
-
-A GitBook plugin is a NPM package that follows a defined convention.
-
-`gitbook-plugin` is a command line utility to help you create, test and release plugins.
-
-### Bootstrap your first plugin
-
-Install `gitbook-plugin` from NPM:
-
-```
-$ npm install gitbook-plugin -g
-```
-
-Then create your plugin:
-
-```
-$ gitbook-plugin create
-```
-
-You will be asked for a plugin name, and a few other things to complete the creation process.
-
-
-### Publish your plugin

docs/api/components.md

@@ -1,86 +0,0 @@
-# Components
-
-
-## Injection
-
-Plugins can inject components by registering React components to some roles.
-
-#### Register a components
-
-During the initialization phase of your plugin, dispatch the `GitBook.registerComponent` action:
-
-```js
-dispatch(GitBook.registerComponent(MyCustomButton, { role: 'toolbar:buttons:left' }));
-```
-
-#### Roles
-
-Custom roles can be use for interopability with other plugins, but GitBook and the default theme set a convention for common roles:
-
-| Role | Description | Props |
-| ---- | ----------- | ----- |
-| `page:container` | DIV container for the page's content | `{ page: Page }` |
-| `summary:container` | DIV container for the whole summary | `{ summary: Summary }` |
-| `summary:parts` | DIV container for summary's parts | `{ parts: List<SummaryPart> }` |
-| `summary:part` | DIV for a specific part | `{ part: SummaryPart }` |
-| `summary:articles` | UL container for a part's articles | `{ articles: List<SummaryArticle> }` |
-| `summary:article` | LI for a specific article | `{ article: SummaryArticle }` |
-
-## Default Components
-
-#### `GitBook.Head`
-
-Extends the meta tags of the page. This is an alias for [react-helmet](https://github.com/nfl/react-helmet).
-
-```js
-<GitBook.Head
-    title="My page"
-  />
-```
-
-#### `GitBook.ImportCSS`
-
-Import a CSS file by resolving the path correctly according to the current page:
-
-```js
-<GitBook.ImportCSS href="myfile.css" />
-```
-
-#### `GitBook.ImportJS`
-
-Import a JS file by resolving the path correctly according to the current page:
-
-```js
-<GitBook.ImportJS src="mylib.js" />
-```
-
-#### `GitBook.InjectedComponent`
-
-Inject a component matching a specific role:
-
-```js
-<GitBook.InjectedComponent matching={{ role: 'mycustomrole' }} props={{ someProp: 1 }}>
-    <b>Inner content</b>
-</GitBook.InjectedComponent>
-```
-
-#### `GitBook.InjectedComponentSet`
-
-Same API as `InjectedComponentSet` but render the matching components in chain instead of composed:
-
-```js
-<GitBook.InjectedComponentSet matching={{ role: 'mytoolbar' }} />
-```
-
-**Warning:** Children are discarded.
-
-#### `GitBook.FlexLayout` and `GitBook.FlexBox`
-
-A simple wrapper that provides a Flexbox layout with the given direction and style. Any additional props you set on the Flexbox are rendered.
-
-```js
-<GitBook.FlexLayout column>
-    <GitBook.FlexBox>First column</GitBook.FlexBox>
-    <GitBook.FlexBox>Second column</GitBook.FlexBox>
-</GitBook.FlexLayout>
-```

docs/api/connect.md

@@ -1,33 +0,0 @@
-# Connect to the context
-
-`GitBook.connect(Component, [mapStateToProps], [mapActionsToProps])` connects a react component to the GitBook context.
-
-It does not modify the component class passed to it.
-Instead, it returns a new, connected component class, for you to use.
-
-### `mapStateToProps(state, [ownProps]): stateProps`
-
-If specified, the component will subscribe to GitBook store updates. Any time it updates, `mapStateToProps` will be called. Its result must be a plain object, and it will be merged into the component’s props.
-
-If you omit it, the component will not be subscribed to the GitBook store. If `ownProps` is specified as a second argument, its value will be the props passed to your component, and `mapStateToProps` will be additionally re-invoked whenever the component receives new props (e.g. if props received from a parent component have shallowly changed, and you use the `ownProps` argument, `mapStateToProps` is re-evaluated).
-
-For example to render the title of the current page:
-
-```js
-const GitBook = require('gitbook-core');
-
-let PageTitle = React.createClass({
-    render() {
-        const { page } = this.props;
-        return <h1>{page.title}</h1>;
-    }
-});
-
-function mapStateToProps(state) {
-    return { page: state.page };
-}
-
-PageTitle = GitBook.connect(PageTitle, mapStateToProps);
-```
-
-### `mapActionsToProps(actions, [dispatch])`

docs/api/i18n.md

@@ -1,44 +0,0 @@
-# Internationalize your plugin
-
-GitBook has built-in support for internationalization. Plugins can register new languages and provide the right messages for different languages.
-
-### Register locale and messages
-
-The first step is to register messages for a language:
-
-```js
-module.exports = GitBook.createPlugin({
-    init: (dispatch, getState, { I18n }) => {
-        dispatch(I18n.registerLocale('en-US', {
-            MY_PLUGIN_MESSAGE: 'Hello World'
-        }));
-    }
-});
-```
-
-### Render a message in a component
-
-`GitBook.connect` adds a `i18n` prop to access the internationalization:
-
-```js
-const GitBook = require('gitbook-core');
-const { React } = GitBook;
-
-const MyButton = React.createClass({
-    propTypes: {
-        i18n: GitBook.Shapes.i18n
-    },
-
-    render() {
-        const { i18n } = this.props;
-
-        return (
-            <GitBook.Button>
-                {i18.t('MY_PLUGIN_MESSAGE')}
-            </GitBook.Button>
-        );
-    }
-});
-
-module.exports = GitBook.connect(MyButton);
-```

docs/api/navigation.md

@@ -1,23 +0,0 @@
-# Navigation
-
-### Listen to url change
-
-Listen for changes to the current location:
-
-```js
-const onLocationChanged = (location) => {
-    console.log(location.pathname);
-    console.log(location.query);
-    console.log(location.hash);
-};
-
-module.exports = GitBook.createPlugin({
-    init: (dispatch, getState, { Navigation }) => {
-        dispatch(Navigation.listen(onLocationChanged));
-    }
-});
-```
-
-The `onLocationChanged` will be triggered for initial state.
-
-### Changing the url

docs/api/node.md

@@ -1,97 +0,0 @@
-# Node APIs
-
-GitBooks provides different Node APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly.
-
-#### Book instance
-
-The `Book` interface is the central point of GitBook, it centralize all access read methods.
-
-```js
-// Read configuration from book.json
-var value = book.config.get('title', 'Default Value');
-
-// Resolve a filename to an absolute path
-var filepath = book.resolve('README.md');
-
-// Render an inline markup string
-book.renderInline('markdown', 'This is **Markdown**')
-    .then(function(str) { ... })
-
-// Render a markup string (block mode)
-book.renderBlock('markdown', '* This is **Markdown**')
-    .then(function(str) { ... })
-```
-
-#### Output instance
-
-The `Output` class represent the output/write process.
-
-```js
-// Return root folder for the output
-var root = output.root();
-
-// Resolve a file in the output folder
-var filepath = output.resolve('myimage.png');
-
-// Convert a filename to an URL (returns a path to an html file)
-var fileurl = output.toURL('mychapter/README.md');
-
-// Write a file in the output folder
-output.writeFile('hello.txt', 'Hello World')
-    .then(function() { ... });
-
-// Copy a file to the output folder
-output.copyFile('./myfile.jpg', 'cover.jpg')
-    .then(function() { ... });
-
-// Verify that a file exists
-output.hasFile('hello.txt')
-    .then(function(exists) { ... });
-```
-
-#### Page instance
-
-A page instance represent the current parsed page.
-
-```js
-// Title of the page (from SUMMARY)
-page.title
-
-// Content of the page (Markdown/Asciidoc/HTML according to the stage)
-page.content
-
-// Relative path in the book
-page.path
-
-// Absolute path to the file
-page.rawPath
-
-// Type of parser used for this file
-page.type ('markdown' or 'asciidoc')
-```
-
-#### Context for Blocks and Filters
-
-Blocks and filters have access to the same context, this context is bind to the template engine execution:
-
-```js
-{
-    // Current templating syntax
-    "ctx": {
-        // For example, after a {% set message = "hello" %}
-        "message": "hello"
-    },
-
-    // Book instance
-    "book" <Book>,
-
-    // Output instance
-    "output": <Output>
-}
-```
-
-For example a filter or block function can access the current book using: `this.book`.
-
-#### Context for Hooks
-
-Hooks only have access to the `<Book>` instance using `this.book`.

docs/config.md

@@ -1,55 +0,0 @@
-# Configuration
-
-GitBook allows you to customize your book using a flexible configuration. These options are specified in a `book.json` file. For authors unfamiliar with the JSON syntax, you can validate the syntax using tools such as [JSONlint](http://jsonlint.com).
-
-### General Settings
-
-| Variable | Description |
-| -------- | ----------- |
-| `root` | Path to the root folder containing all the book's files, except `book.json`|
-| `structure` | To specify paths for Readme, Summary, Glossary etc. See [Structure paragraph](#structure). |
-| `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
-| `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
-| `author` | Name of the author. On GitBook.com this field is pre-filled. |
-| `isbn` | ISBN of the book |
-| `language` | [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the book's language, default value is `en` |
-| `direction` | Text's direction. Can be `rtl` or `ltr`, the default value depends on the value of `language` |
-| `gitbook` | Version of GitBook that should be used. Uses the [SemVer](http://semver.org) specification and accepts conditions like `">= 3.0.0"` |
-
-### Plugins
-
-Plugins and their configurations are specified in the `book.json`. See [the plugins section](plugins/README.md) for more details.
-
-Since version 3.0.0, GitBook can use themes. See [the theming section](themes/README.md) for more details.
-
-| Variable | Description |
-| -------- | ----------- |
-| `plugins` | List of plugins to load |
-| `pluginsConfig` |Configuration for plugins |
-
-### Structure
-
-In addition to the `root` variable, you can tell Gitbook the name of the files for Readme, Summary, Glossary, Languages (instead of using the default names such as `README.md`).
-These files must be at the root of your book (or the root of every language book). Paths such as `dir/MY_README.md` are not accepted.
-
-| Variable | Description |
-| -------- | ----------- |
-| `structure.readme` | Readme file name (defaults to `README.md`) |
-| `structure.summary` | Summary file name (defaults to `SUMMARY.md`) |
-| `structure.glossary` | Glossary file name (defaults to `GLOSSARY.md`) |
-| `structure.languages` | Languages file name (defaults to `LANGS.md`) |
-
-### PDF Options
-
-PDF Output can be customized using a set of options in the `book.json`:
-
-| Variable | Description |
-| -------- | ----------- |
-| `pdf.pageNumbers` | Add page numbers to the bottom of every page (default is `true`) |
-| `pdf.fontSize` | Base font size (default is `12`) |
-| `pdf.fontFamily` | Base font family (default is `Arial`) |
-| `pdf.paperSize` | Paper size, options are `'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter'` (default is `a4`) |
-| `pdf.margin.top` | Top margin (default is `56`) |
-| `pdf.margin.bottom` | Bottom margin (default is `56`) |
-| `pdf.margin.right` | Right margin (default is `62`) |
-| `pdf.margin.left` | Left margin (default is `62`) |

docs/ebook.md

@@ -1,55 +0,0 @@
-# Generating eBooks and PDFs
-
-GitBook can generates a website, but can also output content as ebook (ePub, Mobi, PDF).
-
-```
-# Generate a PDF file
-$ gitbook pdf ./ ./mybook.pdf
-
-# Generate an ePub file
-$ gitbook epub ./ ./mybook.epub
-
-# Generate a Mobi file
-$ gitbook mobi ./ ./mybook.mobi
-```
-
-### Installing ebook-convert
-
-`ebook-convert` is required to generate ebooks (epub, mobi, pdf).
-
-##### GNU/Linux
-
-Install the [Calibre application](https://calibre-ebook.com/download).
-
-```
-$ sudo aptitude install calibre
-```
-
-In some GNU/Linux distributions node is installed as nodejs, you need to manually create a symlink:
-
-```
-$sudo ln -s /usr/bin/nodejs /usr/bin/node
-```
-
-##### OS X
-
-Download the [Calibre application](https://calibre-ebook.com/download). After moving the `calibre.app` to your Applications folder create a symbolic link to the ebook-convert tool:
-
-```
-$ sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin
-```
-
-You can replace `/usr/bin` with any directory that is in your $PATH.
-
-### Cover
-
-Covers are used for all the ebook formats. You can either provide one yourself, or generate one using the [autocover plugin](https://plugins.gitbook.com/plugin/autocover).
-
-To provide a cover, place a **`cover.jpg`** file at the root directory of your book. Adding a **`cover_small.jpg`** will specify a smaller version of the cover. The cover should be a **JPEG** file.
-
-A good cover should respect the following guidelines:
-
-* Size of 1800x2360 pixels for `cover.jpg`, 200x262 for `cover_small.jpg`
-* No border
-* Clearly visible book title
-* Any important text should be visible in the small version

docs/examples.md

@@ -1,28 +0,0 @@
----
-description: Real world examples of content published using GitBook.
----
-
-# Examples
-
-More than 50,000 books have been published on [GitBook.com](https://www.gitbook.com/explore).
-
-### Books
-
-- [Front-end Handbook](https://www.gitbook.com/book/frontendmasters/front-end-handbook/details) by [Cody Lindley](http://codylindley.com)
-- [How to make an Operating System](https://www.gitbook.com/book/samypesse/how-to-create-an-operating-system/details) by [@SamyPesse](https://github.com/SamyPesse)
-- [Building Web Apps with Go](https://www.gitbook.com/book/codegangsta/building-web-apps-with-go/details) by [@codegangsta](https://github.com/codegangsta)
-- [Django Girls Tutorial](http://tutorial.djangogirls.org/en/index.html) by [Django Girls](https://djangogirls.org)
-- [Linux Inside](https://www.gitbook.com/book/0xax/linux-insides/details) by [0xAX](https://twitter.com/0xAX)
-- [Learn Javascript](https://www.gitbook.com/book/gitbookio/javascript/details) by [GitBook](https://twitter.com/GitbookIO)
-
-### Research Papers
-
-- [TowCenter Collection](https://www.gitbook.com/@towcenter) by [Columbia Journalism School](http://www.journalism.columbia.edu/)
-- [Block Relaxation Algorithms in Statistics](https://www.gitbook.com/@jandeleeuw) by Jan de Leeuw
-
-### Documentation
-
-- [DuckDuckHack Documentation](http://docs.duckduckhack.com) by [DuckDuckGo](https://duckduckgo.com/about)
-- [Loomio Handbook](http://loomio.coop/) and [guide to using Loomio](https://loomio.gitbooks.io/manual/content/en/index.html) both by [Loomio](https://www.loomio.org/)
-- [Enspiral Handbook](http://handbook.enspiral.com/) by [Enspiral](http://enspiral.com/)
-- This documentation

docs/faq.md

@@ -1,55 +0,0 @@
-# GitBook FAQ
-
-This page gathers common questions and answers concerning the GitBook format and toolchain.
-
-Questions about GitBook.com and the Editor are gather into the [help.gitbook.com's FAQ](http://help.gitbook.com/faq.html).
-
-#### How can I host/publish my book?
-
-Books can easily be published and hosted on [GitBook.com](https://www.gitbook.com). But GitBook output can be hosted on any static file hosting solution.
-
-#### What can I use to edit my content?
-
-Any text editor should work! But we advise using the [GitBook Editor](https://www.gitbook.com/editor). [GitBook.com](https://www.gitbook.com) also provides a web version of this editor.
-
----
-
-#### Does GitBook supports RTL/bi-directional text ?
-
-The GitBook format supports right to left, and bi-directional writing. To enable it, you either need to specify a language (ex: `ar`), or force GitBook to use RTL in your `book.json`:
-
-```json
-{
-    "language": "ar",
-    "direction": "rtl"
-}
-```
-
-With version 3.0 of GitBook, it's automatically detected according to the content.
-_Note that, while the output book will indeed respect RTL, the Editor doesn't support RTL writing yet_.
-
-#### Should I use an `.html` or `.md` extensions in my links?
-
-You should always use paths and the `.md` extensions when linking to your files, GitBook will automatically replace these paths by the appropriate link when the pointing file is referenced in the Table of Contents.
-
-#### Can I create a GitBook in a sub-directory of my repository?
-
-Yes, GitBooks can be created in [sub-directories](structure.md#subdirectory). GitBook.com and the CLI also looks by default in a series of [folders](structure.md).
-
-#### Does GitBook supports RTL languages?
-
-Yes, GitBook automatically detect the direction in your pages (`rtl` or `ltr`) and adjust the layout accordingly. The direction can also be specified globally in the [book.json](config.md).
-
----
-
-#### Does GitBook support Math equations?
-
-GitBook supports math equations and TeX thanks to plugins. There are currently 2 official plugins to display math: [mathjax](https://plugins.gitbook.com/plugin/mathjax) and [katex](https://plugins.gitbook.com/plugin/katex).
-
-#### Can I customize/theme the output?
-
-Yes, both the website and ebook outputs can be customized using [themes](themes/README.md).
-
-#### Can I add interactive content (videos, etc)?
-
-GitBook is very [extensible](plugins/README.md). You can use [existing plugins](https://plugins.gitbook.com) or create your own!

docs/languages.md

@@ -1,17 +0,0 @@
-# Multi-Languages
-
-GitBook supports building books written in multiple languages. Each language should be a sub-directory following the normal GitBook format, and a file named `LANGS.md` should be present at the root of the repository with the following format:
-
-```markdown
-# Languages
-
-* [English](en/)
-* [French](fr/)
-* [Español](es/)
-```
-
-### Configuration for each language
-
-When a language book (ex: `en`) has a `book.json`, its configuration will extend the main configuration.
-
-The only exception is plugins, plugins are specified globally, and language specific plugins cannot be specified.

docs/lexicon.md

@@ -1,14 +0,0 @@
-# Glossary
-
-Allows you to specify terms and their respective definitions to be displayed as annotations. Based on those terms, GitBook will automatically build an index and highlight those terms in pages.
-
-The `GLOSSARY.md` format is a list of `h2` headings, along with a description paragraph:
-
-```markdown
-## Term
-Definition for this term
-
-## Another term
-With it's definition, this can contain bold text
-and all other kinds of inline markup ...
-```

docs/pages.md

@@ -1,103 +0,0 @@
-# Pages and Summary
-
-### Summary
-
-GitBook uses a `SUMMARY.md` file to define the structure of chapters and subchapters of the book. The `SUMMARY.md` file is used to generate the book's table of contents.
-
-The format of `SUMMARY.md` is just a list of links. The link's title is used as the chapter's title, and the link's target is a path to that chapter's file.
-
-Adding a nested list to a parent chapter will create subchapters.
-
-##### Simple example
-
-```markdown
-# Summary
-
-* [Part I](part1/README.md)
-    * [Writing is nice](part1/writing.md)
-    * [GitBook is nice](part1/gitbook.md)
-* [Part II](part2/README.md)
-    * [We love feedback](part2/feedback_please.md)
-    * [Better tools for authors](part2/better_tools.md)
-```
-
-Each chapter has a dedicated page (`part#/README.md`) and is split into subchapters.
-
-##### Anchors
-
-Chapters in the Table of Contents can be pointing to specific part of a file using anchor.
-
-```markdown
-# Summary
-
-### Part I
-
-* [Part I](part1/README.md)
-    * [Writing is nice](part1/README.md#writing)
-    * [GitBook is nice](part1/README.md#gitbook)
-* [Part II](part2/README.md)
-    * [We love feedback](part2/README.md#feedback)
-    * [Better tools for authors](part2/README.md#tools)
-```
-
-##### Parts
-
-The Table of Contents can be divided into parts separated by headings or horizontal lines:
-
-```markdown
-# Summary
-
-### Part I
-
-* [Writing is nice](part1/writing.md)
-* [GitBook is nice](part1/gitbook.md)
-
-### Part II
-
-* [We love feedback](part2/feedback_please.md)
-* [Better tools for authors](part2/better_tools.md)
-
-----
-
-* [Last part without title](part3/title.md)
-```
-
-Parts are just groups of chapters and do not have dedicated pages, but according to the theme, it will show in the navigation.
-
-### Pages
-
-#### Markdown syntax
-
-Most of the files for GitBook use the Markdown syntax by default. GitBook infers your pages's structure from it. The syntax used is similar to the [GitHub Flavored Markdown syntax](https://guides.github.com/features/mastering-markdown/). One can also opt for the [AsciiDoc syntax](asciidoc.md).
-
-##### Example of a chapter file
-
-```markdown
-# Title of the chapter
-
-This is a great introduction.
-
-## Section 1
-
-Markdown will dictates _most_ of your **book's structure**
-
-## Section 2
-
-...
-
-```
-
-#### Front Matter
-
-Pages can contain an optional front matter. It can be used to define the page's description. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:
-
-```yaml
----
-description: This is a short description of my page
----
-
-# The content of my page
-...
-```
-
-The front matter can define variables of your own, they will be added to the [page variable](templating/variables.md) so you can use them in your templating.

docs/plugins/README.md

@@ -1,28 +0,0 @@
-# Plugins
-
-Plugins are the best way to extend GitBook functionalities (ebook and website). There exist plugins to do a lot of things: bring math formulas display support, track visits using Google Analytics, etc.
-
-### How to find plugins?
-
-Plugins can be easily searched on [plugins.gitbook.com](https://plugins.gitbook.com).
-
-
-### How to install a plugin?
-
-Once you find a plugin that you want to install, you need to add it to your `book.json`:
-
-```
-{
-    "plugins": ["myPlugin", "anotherPlugin"]
-}
-```
-
-You can also specify a specific version using: `"myPlugin@0.3.1"`. By default GitBook will resolve the latest version of the plugin compatbile with the current GitBook version.
-
-### GitBook.com
-
-Plugins are automatically installed on [GitBook.com](https://www.gitbook.com). Locally, run `gitbook install` to install and prepare all plugins for your books.
-
-### Configuring plugins
-
-Plugins specific configurations are stored in `pluginsConfig`. You have to refer to the documentation of the plugin itself for details about the available options.

docs/plugins/api.md

@@ -1,97 +0,0 @@
-# Context and APIs
-
-GitBooks provides different APIs and contexts to plugins. These APIs can vary according to the GitBook version being used, your plugin should specify the `engines.gitbook` field in `package.json` accordingly.
-
-#### Book instance
-
-The `Book` class is the central point of GitBook, it centralize all access read methods. This class is defined in [book.js](https://github.com/GitbookIO/gitbook/blob/master/book.js).
-
-```js
-// Read configuration from book.json
-var value = book.config.get('title', 'Default Value');
-
-// Resolve a filename to an absolute path
-var filepath = book.resolve('README.md');
-
-// Render an inline markup string
-book.renderInline('markdown', 'This is **Markdown**')
-    .then(function(str) { ... })
-
-// Render a markup string (block mode)
-book.renderBlock('markdown', '* This is **Markdown**')
-    .then(function(str) { ... })
-```
-
-#### Output instance
-
-The `Output` class represent the output/write process.
-
-```js
-// Return root folder for the output
-var root = output.root();
-
-// Resolve a file in the output folder
-var filepath = output.resolve('myimage.png');
-
-// Convert a filename to an URL (returns a path to an html file)
-var fileurl = output.toURL('mychapter/README.md');
-
-// Write a file in the output folder
-output.writeFile('hello.txt', 'Hello World')
-    .then(function() { ... });
-
-// Copy a file to the output folder
-output.copyFile('./myfile.jpg', 'cover.jpg')
-    .then(function() { ... });
-
-// Verify that a file exists
-output.hasFile('hello.txt')
-    .then(function(exists) { ... });
-```
-
-#### Page instance
-
-A page instance represent the current parsed page.
-
-```js
-// Title of the page (from SUMMARY)
-page.title
-
-// Content of the page (Markdown/Asciidoc/HTML according to the stage)
-page.content
-
-// Relative path in the book
-page.path
-
-// Absolute path to the file
-page.rawPath
-
-// Type of parser used for this file
-page.type ('markdown' or 'asciidoc')
-```
-
-#### Context for Blocks and Filters
-
-Blocks and filters have access to the same context, this context is bind to the template engine execution:
-
-```js
-{
-    // Current templating syntax
-    "ctx": {
-        // For example, after a {% set message = "hello" %}
-        "message": "hello"
-    },
-
-    // Book instance
-    "book" <Book>,
-
-    // Output instance
-    "output": <Output>
-}
-```
-
-For example a filter or block function can access the current book using: `this.book`.
-
-#### Context for Hooks
-
-Hooks only have access to the `<Book>` instance using `this.book`.

docs/plugins/blocks.md

@@ -1,62 +0,0 @@
-# Extend Blocks
-
-Extending templating blocks is the best way to provide extra functionalities to authors.
-
-The most common usage is to process the content within some tags at runtime. It's like [filters](./filters.md), but on steroids because you aren't confined to a single expression.
-
-### Defining a new block
-
-Blocks are defined by the plugin, blocks is a map of name associated with a block descriptor. The block descriptor needs to contain at least a `process` method.
-
-```js
-module.exports = {
-    blocks: {
-        tag1: {
-            process: function(block) {
-                return "Hello "+block.body+", How are you?";
-            }
-        }
-    }
-};
-```
-
-The `process` should return the html content that will replace the tag. Refer to [Context and APIs](./api.md) to learn more about `this` and GitBook API.
-
-### Handling block arguments
-
-Arguments can be passed to blocks:
-
-```
-{% tag1 "argument 1", "argument 2", name="Test" %}
-This is the body of the block.
-{% endtag1 %}
-```
-
-And arguments are easily accessible in the `process` method:
-
-```js
-module.exports = {
-    blocks: {
-        tag1: {
-            process: function(block) {
-                // block.args equals ["argument 1", "argument 2"]
-                // block.kwargs equals { "name": "Test" }
-            }
-        }
-    }
-};
-```
-
-### Handling sub-blocks
-
-A defined block can be parsed into different sub-blocks, for example let's consider the source:
-
-```
-{% myTag %}
-    Main body
-    {% subblock1 %}
-    Body of sub-block 1
-    {% subblock 2 %}
-    Body of sub-block 1
-{% endmyTag %}
-```

docs/plugins/create.md

@@ -1,74 +0,0 @@
-# Create and publish a plugin
-
-A GitBook plugin is a node package published on NPM that follow a defined convention.
-
-## Structure
-
-#### package.json
-
-The `package.json` is a manifest format for describing **Node.js modules**. GitBook plugins are built on top of Node modules. It declares dependencies, version, ownership, and other information required to run a plugin in GitBook. This document describes the schema in detail.
-
-A plugin manifest `package.json` can also contain details about the required configuration. The configuration schema is defined in the `gitbook` field of the `package.json` (This field follow the [JSON-Schema](http://json-schema.org) guidelines):
-
-```js
-{
-    "name": "gitbook-plugin-mytest",
-    "version": "0.0.1",
-    "description": "This is my first GitBook plugin",
-    "engines": {
-        "gitbook": ">1.x.x"
-    },
-    "gitbook": {
-        "properties": {
-            "myConfigKey": {
-                "type": "string",
-                "default": "it's the default value",
-                "description": "It defines my awesome config!"
-            }
-        }
-    }
-}
-```
-
-You can learn more about `package.json` from the [NPM documentation](https://docs.npmjs.com/files/package.json).
-
-The **package name** must begin with `gitbook-plugin-` and the **package engines** should contains `gitbook`.
-
-#### index.js
-
-The `index.js` is main entry point of your plugin runtime:
-
-```js
-module.exports = {
-    // Map of hooks
-    hooks: {},
-
-    // Map of new blocks
-    blocks: {},
-
-    // Map of new filters
-    filters: {}
-};
-```
-
-## Publish your plugin
-
-GitBook plugins can be published on [NPM](https://www.npmjs.com).
-
-To publish a new plugin, you need to create an account on [npmjs.com](https://www.npmjs.com) then publish it from the command line:
-
-```
-$ npm publish
-```
-
-## Private plugins
-
-Private plugins can be hosted on GitHub and included using `git` urls:
-
-```
-{
-    "plugins": [
-        "myplugin@git+https://github.com/MyCompany/mygitbookplugin.git#1.0.0"
-    ]
-}
-```

docs/plugins/filters.md

@@ -1,57 +0,0 @@
-# Extend Filters
-
-Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments.
-
-```
-{{ foo | title }}
-{{ foo | join(",") }}
-{{ foo | replace("foo", "bar") | capitalize }}
-```
-
-### Defining a new filter
-
-Plugins can extend filters by defining custom functions in their entry point under the `filters` scope.
-
-A filter function takes as first argument the content to filter, and should return the new content.
-Refer to [Context and APIs](./api.md) to learn more about `this` and GitBook API.
-
-```js
-module.exports = {
-    filters: {
-        hello: function(name) {
-            return 'Hello '+name;
-        }
-    }
-};
-```
-
-The filter `hello` can then be used in the book:
-
-```
-{{ "Aaron"|hello }}, how are you?
-```
-
-### Handling block arguments
-
-Arguments can be passed to filters:
-
-```
-Hello {{ "Samy"|fullName("Pesse", man=true}} }}
-```
-
-Arguments are passed to the function, named-arguments are passed as a last argument (object).
-
-```js
-module.exports = {
-    filters: {
-        fullName: function(firstName, lastName, kwargs) {
-            var name = firstName + ' ' + lastName;
-
-            if (kwargs.man) name = "Mr" + name;
-            else name = "Mrs" + name;
-
-            return name;
-        }
-    }
-};
-```

docs/plugins/hooks.md

@@ -1,89 +0,0 @@
-# Hooks
-
-Hooks is a method of augmenting or altering the behavior of the process, with custom callbacks.
-
-### List of hooks
-
-### Relative to the global pipeline
-
-| Name | Description | Arguments |
-| ---- | ----------- | --------- |
-| `init` | Called after parsing the book, before generating output and pages. | None |
-| `finish:before` | Called after generating the pages, before copying assets, cover, ... | None |
-| `finish` | Called after everything else. | None |
-
-### Relative to the page pipeline
-
-> It is recommended using [templating](./templating.md) to extend page parsing.
-
-| Name | Description | Arguments |
-| ---- | ----------- | --------- |
-| `page:before` | Called before running the templating engine on the page | Page Object |
-| `page` | Called before outputting and indexing the page. | Page Object |
-
-##### Page Object
-
-```js
-{
-    // Parser named
-    "type": "markdown",
-
-    // File Path relative to book root
-    "path": "page.md",
-
-    // Absolute file path
-    "rawpath": "/usr/...",
-
-    // Title of the page in the SUMMARY
-    "title": "",
-
-    // Content of the page
-    // Markdown/Asciidoc in "page:before"
-    // HTML in "page"
-    "content": "# Hello"
-}
-```
-
-##### Example to add a title
-
-In the `page:before` hook, `page.content` is the markdown/asciidoc content.
-
-```js
-{
-    "page:before": function(page) {
-        page.content = "# Title\n" +page.content;
-        return page;
-    }
-}
-```
-
-##### Example to replace some html
-
-In the `page` hook, `page.content` is the HTML generated from the markdown/asciidoc conversion.
-
-```js
-{
-    "page": function(page) {
-        page.content = page.content.replace("<b>", "<strong>")
-            .replace("</b>", "</strong>");
-        return page;
-    }
-}
-```
-
-### Asynchronous Operations
-
-Hooks callbacks can be asynchronous and return promises.
-
-Example:
-
-```js
-{
-    "init": function() {
-        return writeSomeFile()
-        .then(function() {
-            return writeAnotherFile();
-        });
-    }
-}
-```

docs/plugins/testing.md

@@ -1,21 +0,0 @@
-# Testing your plugin
-
-### Testing your plugin locally
-
-Testing your plugin on your book before publishing it is possible using [npm link](https://docs.npmjs.com/cli/link).
-
-In the plugin's folder, run:
-
-```
-$ npm link
-```
-
-Then in your book's folder:
-
-```
-$ npm link gitbook-plugin-<plugin's name>
-```
-
-### Unit testing on Travis
-
-[gitbook-tester](https://github.com/todvora/gitbook-tester) makes it easy to write **Node.js/Mocha** unit tests for your plugins. Using [Travis.org](https://travis.org), tests can be run on each commits/tags.

docs/setup.md

@@ -1,68 +0,0 @@
-# Setup and Installation of GitBook
-
-Getting GitBook installed and ready-to-go should only take a few minutes.
-
-### GitBook.com
-
-[GitBook.com](https://www.gitbook.com) is an easy to use solution to write, publish and host books. It is the easiest solution for publishing your content and collaborating on it.
-
-It integrates well with the [GitBook Editor](https://www.gitbook.com/editor).
-
-### Local Installation
-
-##### Requirements
-
-Installing GitBook is easy and straightforward. Your system just needs to meet these two requirements:
-
-* NodeJS (v4.0.0 and above is recommended)
-* Windows, Linux, Unix, or Mac OS X
-
-##### Install with NPM
-
-The best way to install GitBook is via **NPM**. At the terminal prompt, simply run the following command to install GitBook:
-
-```
-$ npm install gitbook-cli -g
-```
-
-`gitbook-cli` is an utility to install and use multiple versions of GitBook on the same system. It will automatically install the required version of GitBook to build a book.
-
-##### Create a book
-
-GitBook can setup a boilerplate book:
-
-```
-$ gitbook init
-```
-
-If you wish to create the book into a new directory, you can do so by running `gitbook init ./directory`
-
-Preview and serve your book using:
-
-```
-$ gitbook serve
-```
-
-Or build the static website using:
-
-```
-$ gitbook build
-```
-
-##### Install pre-releases
-
-`gitbook-cli` makes it easy to download and install other versions of GitBook to test with your book:
-
-```
-$ gitbook fetch beta
-```
-
-Use `gitbook ls-remote` to list remote versions available for install.
-
-##### Debugging
-
-You can use the options `--log=debug` and `--debug` to get better error messages (with stack trace). For example:
-
-```
-$ gitbook build ./ --log=debug --debug
-```

docs/structure.md

@@ -1,66 +0,0 @@
-# Directory Structure
-
-GitBook uses a simple directory structure. All Markdown/Asciidoc files listed in the [SUMMARY](pages.md) will be transformed as HTML. Multi-Lingual books have a slightly [different structure](languages.md).
-
-A basic GitBook usually looks something like this:
-
-```
-.
-├── book.json
-├── README.md
-├── SUMMARY.md
-├── chapter-1/
-|   ├── README.md
-|   └── something.md
-└── chapter-2/
-    ├── README.md
-    └── something.md
-```
-
-An overview of what each of these does:
-
-| File | Description |
-| -------- | ----------- |
-| `book.json` | Stores [configuration](config.md) data (__optional__) |
-| `README.md` | Preface / Introduction for your book (**required**) |
-| `SUMMARY.md` | Table of Contents (See [Pages](pages.md)) (__optional__) |
-| `GLOSSARY.md` | Lexicon / List of terms to annotate (See [Glossary](lexicon.md)) (__optional__) |
-
-### Static files and Images
-
-A static file is a file that is not listed in the `SUMMARY.md`. All static files, unless [ignored](#ignore), are copied to the output.
-
-### Ignoring files & folders {#ignore}
-
-GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip.
-The format inside those files, follows the same convention as `.gitignore`:
-
-```
-# This is a comment
-
-# Ignore the file test.md
-test.md
-
-# Ignore everything in the directory "bin"
-bin/*
-```
-
-### Project integration with subdirectory {#subdirectory}
-
-For software projects, you can use a subdirectory (like `docs/`) to store the book for the project's documentation. You can configure the [`root` option](config.md) to indicate the folder where GitBook can find the book's files:
-
-```
-.
-├── book.json
-└── docs/
-    ├── README.md
-    └── SUMMARY.md
-```
-
-With `book.json` containing:
-
-```
-{
-    "root": "./docs"
-}
-```

docs/styles/website.css

@@ -1,4 +0,0 @@
-/* Reduce size of logo to allow long versions like 3.0.0-pre.1 */
-.gb-page-header .container .logo h1 {
-    font-size: 24px ;
-}

docs/syntax/asciidoc.md

@@ -1,64 +0,0 @@
-# AsciiDoc
-
-Since version `2.0.0`, GitBook can also accept AsciiDoc as an input format.
-
-Please refer to the [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) for more informations about the format.
-
-Just like for markdown, GitBook is using some special files to extract structures: `README.adoc`, `SUMMARY.adoc`, `LANGS.adoc` and `GLOSSARY.adoc`.
-
-### README.adoc
-
-This is the main entry of your book: the introduction. This file is **required**.
-
-### SUMMARY.adoc
-
-This file defines the list of chapters and subchapters. Just like in Markdown, the `SUMMARY.adoc`'s format is simply a list of links, the name of the link is used as the chapter's name, and the target is a path to that chapter's file.
-
-Subchapters are defined simply by adding a nested list to a parent chapter.
-
-```asciidoc
-= Summary
-
-. link:chapter-1/README.adoc[Chapter 1]
-.. link:chapter-1/ARTICLE1.adoc[Article 1]
-.. link:chapter-1/ARTICLE2.adoc[Article 2]
-... link:chapter-1/ARTICLE-1-2-1.adoc[Article 1.2.1]
-. link:chapter-2/README.adoc[Chapter 2]
-. link:chapter-3/README.adoc[Chapter 3]
-. link:chapter-4/README.adoc[Chapter 4]
-.. Unfinished article
-. Unfinished Chapter
-```
-
-### LANGS.adoc
-
-For [Multi-Languages](./languages.md) books, this file is used to define the different supported languages and translations.
-
-This file is following the same syntax as the `SUMMARY.adoc`:
-
-```asciidoc
-= Languages
-
-. link:en/[English]
-. link:fr/[French]
-```
-
-### GLOSSARY.adoc
-
-This file is used to define terms. [See the glossary section](./lexicon.md).
-
-```asciidoc
-= Glossary
-
-== Magic
-
-Sufficiently advanced technology, beyond the understanding of the
-observer producing a sense of wonder.
-
-== PHP
-
-A popular web programming language, used by many large websites such
-as Facebook. Rasmus Lerdorf originally created PHP in 1994 to power
-his personal homepage (PHP originally stood for "Personal Home Page"
-but now stands for "PHP: Hypertext Preprocessor").
-```

docs/syntax/markdown.md

@@ -1,223 +0,0 @@
-# Markdown
-
-Most of the examples from this documentation are in Markdown. Markdown is default parser for GitBook, but one can also opt for the [AsciiDoc syntax](asciidoc.md).
-
-Here’s an overview of Markdown syntax that you can use with GitBook (same as GitHub with some additions).
-
-### Headings
-
-To create a heading, add one to six `#` symbols before your heading text. The number of # you use will determine the size of the heading.
-
-```markdown
-# This is an <h1> tag
-## This is an <h2> tag
-###### This is an <h6> tag
-```
-
-GitBook supports a nice way for explicitly setting the header ID. If you follow the header text with an opening curly bracket (separated from the text with a least one space), a hash, the ID and a closing curly bracket, the ID is set on the header. If you use the trailing hash feature of atx style headers, the header ID has to go after the trailing hashes. For example:
-
-```markdown
-Hello {#id}
------
-
-# Hello {#id}
-
-# Hello # {#id}
-```
-
-### Paragraphs and Line Breaks {#paragraphs}
-
-A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line — a line containing nothing but spaces or tabs is considered blank.) Normal paragraphs should not be indented with spaces or tabs.
-
-```
-Here's a line for us to start with.
-
-This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
-```
-
-### Emphasis {#emphasis}
-
-```markdown
-*This text will be italic*
-_This will also be italic_
-
-**This text will be bold**
-__This will also be bold__
-
-~~This text will be crossed out.~~
-
-_You **can** combine them_
-```
-
-### Lists {#lists}
-
-Markdown supports ordered (numbered) and unordered (bulleted) lists.
-
-##### Unordered
-
-Unordered lists use asterisks, pluses, and hyphens — interchangably — as list markers:
-
-```markdown
-* Item 1
-* Item 2
-  * Item 2a
-  * Item 2b
-```
-
-##### Ordered
-
-Ordered lists use numbers followed by periods:
-
-```markdown
-1. Item 1
-2. Item 2
-3. Item 3
-   * Item 3a
-   * Item 3b
-```
-
-### Links {#links}
-
-Markdown supports two style of links: inline and reference.
-
-A simple link can be created by surrounding the text with square brackets and the link URL with parentheses:
-
-```markdown
-This is [an example](http://example.com/ "Title") inline link with a title.
-
-[This link](http://example.net/) has no title attribute.
-```
-
-Links can point to relative paths, anchors or absolute urls.
-
-
-### References
-
-There is another way to create links which does not interrupt the text flow. The URL and title are defined using a reference name and this reference name is then used in square brackets instead of the link URL:
-
-```markdown
-This is [an example][id] reference-style link.
-```
-
-Then, anywhere in the document, you define your link label like this, on a line by itself:
-
-```markdown
-[id]: http://example.com/  "Optional Title Here"
-```
-
-### Images {#images}
-
-Images can be created in a similar way than links: just use an exclamation mark before the square brackets. The link text will become the alternative text of the image and the link URL specifies the image source:
-
-```markdown
-An image: ![gras](img/image.jpg)
-```
-
-### Blockquotes {#blockquotes}
-
-A blockquote is started using the `>` marker followed by an optional space; all following lines that are also started with the blockquote marker belong to the blockquote. You can use any block-level elements inside a blockquote:
-
-```markdown
-As Kanye West said:
-
-> We're living the future so
-> the present is our past.
-```
-
-### Tables {#tables}
-
-You can create tables by assembling a list of words and dividing them with hyphens `-` (for the first row), and then separating each column with a pipe `|`:
-
-```markdown
-| First Header  | Second Header |
-| ------------- | ------------- |
-| Content Cell  | Content Cell  |
-| Content Cell  | Content Cell  |
-```
-
-The pipes on either end of the table are optional. Cells can vary in width and do not need to be perfectly aligned within columns. There must be at least three hyphens in each column of the header row.
-
-### Code {#code}
-
-Markdown supports two different code block styles. One uses lines indented with either four spaces or one tab whereas the other uses lines with tilde characters as delimiters – therefore the content does not need to be indented:
-
-```markdown
-This is a sample code block.
-
-    Continued here.
-
-```
-
-##### Fenced code blocks
-
-You can create fenced code blocks by placing triple backticks ` ``` ` before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.
-
-    ```
-    function test() {
-      console.log("notice the blank line before this function?");
-    }
-    ```
-
-##### Syntax highlighting
-
-You can add an optional language identifier to enable syntax highlighting in your fenced code block.
-
-For example, to syntax highlight Ruby code:
-
-    ```ruby
-    require 'redcarpet'
-    markdown = Redcarpet.new("Hello World!")
-    puts markdown.to_html
-    ```
-
-##### Inline code
-
-Text phrases can be marked up as code by surrounding them with backticks:
-
-    Use `gitbook` to convert the `text` in markdown
-    syntax to HTML.
-
-### Footnotes
-
-GitBook supports a simple syntax for such footnotes. Footnotes are relative to each pages.
-
-```markdown
-Text prior to footnote reference.[^2]
-
-[^2]: Comment to include in footnote.
-```
-
-### HTML
-
-GitBook supports use of raw HTML in your text, Markdown syntax in HTML is not processed:
-
-```
-<div>
-Markdown here will not be **parsed**
-</div>
-```
-
-### Horizontal Rule
-
-Horizontal Rules can be inserted using three or more asterisks, dashes or underscores, optionally separated by spaces or tabs, on an otherwise blank line:
-
-```markdown
-Three or more...
-
----
-
-Hyphens
-
-***
-
-Asterisks
-
-```
-
-### Ignoring Markdown formatting
-
-You can tell GitBook to ignore (or escape) Markdown formatting by using `\` before the Markdown character.
-
-```
-Let's rename \*our-new-project\* to \*our-old-project\*.
-```

docs/templating/README.md

@@ -1,99 +0,0 @@
-# Templating
-
-GitBook uses the [Nunjucks templating language](https://mozilla.github.io/nunjucks/) to process pages and theme's templates.
-
-The Nunjucks syntax is very similar to **Jinja2** or **Liquid**. Its syntax uses surrounding braces `{ }` to mark content that needs to be processed.
-
-### Variables
-
-A variable looks up a value from the template context. If you wanted to simply display a variable, you would use the `{{ variable }}` syntax. For example :
-
-```twig
-My name is {{ name }}, nice to meet you
-```
-
-This looks up username from the context and displays it. Variable names can have dots in them which lookup properties, just like JavaScript. You can also use the square bracket syntax.
-
-```twig
-{{ foo.bar }}
-{{ foo["bar"] }}
-```
-
-If a value is undefined, nothing is displayed. The following all output nothing if foo is undefined: `{{ foo }}`, `{{ foo.bar }}`, `{{ foo.bar.baz }}`.
-
-GitBook provides a set of [predefined variables](variables.md) from the context.
-
-### Filters
-
-Filters are essentially functions that can be applied to variables. They are called with a pipe operator (`|`) and can take arguments.
-
-```twig
-{{ foo | title }}
-{{ foo | join(",") }}
-{{ foo | replace("foo", "bar") | capitalize }}
-```
-
-The third example shows how you can chain filters. It would display "Bar", by first replacing "foo" with "bar" and then capitalizing it.
-
-### Tags
-
-##### if
-
-`if` tests a condition and lets you selectively display content. It behaves exactly as JavaScript's `if` behaves.
-
-```twig
-{% if variable %}
-  It is true
-{% endif %}
-```
-
-If variable is defined and evaluates to true, "It is true" will be displayed. Otherwise, nothing will be.
-
-You can specify alternate conditions with `elif` and `else`:
-
-```twig
-{% if hungry %}
-  I am hungry
-{% elif tired %}
-  I am tired
-{% else %}
-  I am good!
-{% endif %}
-```
-
-##### for
-
-`for` iterates over arrays and dictionaries.
-
-```twig
-# Chapters about GitBook
-
-{% for article in glossary.terms['gitbook'].articles %}
-* [{{ article.title }}]({{ article.path }})
-{% endfor %}
-```
-
-##### set
-
-`set` lets you create/modify a variable.
-
-```twig
-{% set softwareVersion = "1.0.0" %}
-
-Current version is {{ softwareVersion }}.
-[Download it](website.com/download/{{ softwareVersion }})
-```
-
-##### include and block
-
-Inclusion and inheritance is detailled in the [Content References](conrefs.md) section.
-
-### Escaping
-
-If you want GitBook to ignore any of the special templating tags, you can use raw and anything inside of it will be output as plain text.
-
-```twig
-{% raw %}
-  this will {{ not be processed }}
-{% endraw %}
-```

docs/templating/builtin.md

@@ -1,19 +0,0 @@
-# Builtin Templating Helpers
-
-GitBook provides a serie of builtin filters and blocks to help you write templates.
-
-### Filters
-
-`value|default(default, [boolean])`
-If value is strictly undefined, return default, otherwise value. If boolean is true, any JavaScript falsy value will return default (false, "", etc)
-
-`arr|sort(reverse, caseSens, attr)`
-Sort arr with JavaScript's arr.sort function. If reverse is true, result will be reversed. Sort is case-insensitive by default, but setting caseSens to true makes it case-sensitive. If attr is passed, will compare attr from each item.
-
-### Blocks
-
-`{% markdown %}Markdown string{% endmarkdown %}`
-Render inline markdown
-
-`{% asciidoc %}AsciiDoc string{% endasciidoc %}`
-Render inline asciidoc

docs/templating/conrefs.md

@@ -1,55 +0,0 @@
-# Content References
-
-Content referencing (conref) is a convenient mechanism to reuse content from other files or books.
-
-### Importing local files
-
-Importing an other file's content is easy using the `include` tag:
-
-```
-{% include "./test.md" %}
-```
-
-### Importing file from another book
-
-GitBook can also resolve the include path by using git:
-
-```
-{% include "git+https://github.com/GitbookIO/documentation.git/README.md#0.0.1" %}
-```
-
-The format of git url is:
-
-```
-git+https://user@hostname/owner/project.git/file#commit-ish
-```
-
-The real git url part should finish with `.git`, the filename to import is extracted after the `.git` till the fragment of the url.
-
-The `commit-ish` can be any tag, sha, or branch which can be supplied as an argument to `git checkout`. The default is `master`.
-
-### Inheritance
-
-Template inheritance is a way to make it easy to reuse templates. When writing a template, you can define "blocks" that child templates can override. The inheritance chain can be as long as you like.
-
-`block` defines a section on the template and identifies it with a name. Base templates can specify blocks and child templates can override them with new content.
-
-```
-{% extends "./mypage.md" %}
-
-{% block pageContent %}
-# This is my page content
-{% endblock %}
-```
-
-In the file `mypage.md`, you should specify the blocks that can be extended:
-
-```
-{% block pageContent %}
-This is the default content
-{% endblock %}
-
-# License
-
-{% include "./LICENSE" %}
-```

docs/templating/variables.md

@@ -1,98 +0,0 @@
-# Variables
-
-The following is a reference of the available data during book's parsing and theme generation.
-
-### Global Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `book` | Book-wide information + configuration settings from `book.json`. See below for details. |
-| `gitbook` | GitBook specific information |
-| `page` | Current page specific information |
-| `file` | File associated with the current page specific information |
-| `readme` | Information about the Readme |
-| `glossary` | Information about the Glossary |
-| `summary` | Information about the table of contents |
-| `languages` | List of languages for multi-lingual books |
-| `output` | Information about the output generator |
-| `config` | Dump of the `book.json` |
-
-### Book Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `book.language` | Current language for a multilingual book |
-| `book.[value]` | All other values under `variables` in the `book.json` are accessible here |
-
-For example, with this `book.json`:
-
-```json
-{
-  variables: {
-    hello: "everyone"
-  }
-}
-```
-
-... the following text `{{ book.hello }}` will expand to `everyone`.
-
-### GitBook Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `gitbook.time` | The current time (when you run the `gitbook` command). |
-| `gitbook.version` | Version of GitBook used to generate the book |
-
-### File Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `file.path` | The path to the raw page |
-| `file.mtime` | Modified Time. Last time the file was modified |
-| `file.type` | The name of the parser used to compile this file (ex: `markdown`, `asciidoc`, etc) |
-
-#### Page Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `page.title` | Title of the page |
-| `page.previous` | Previous page in the Table of Contents (can be `null`) |
-| `page.next` | Next page in the Table of Contents (can be `null`) |
-| `page.dir` | Text direction, based on configuration or detected from content (`rtl` or `ltr`) |
-
-#### Table of Contents Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `summary.parts` | List of sections in the Table of Contents |
-
-The whole table of contents (`SUMMARY.md`) can be accessed:
-
-`summary.parts[0].articles[0].title` will return the title of the first article.
-
-#### Multi-lingual book Variable
-
-| Variable | Description |
-| -------- | ----------- |
-| `languages.list` | List of languages for this book |
-
-Languages are defined by `{ id: 'en', title: 'English' }`.
-
-### Output Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `output.name` | Name of the output generator, possible values are `website`, `json`, `ebook` |
-| `output.format` | When `output.name == "ebook"`, `format` defines the ebook format that will be generated, possible values are `pdf`, `epub` or `mobi` |
-
-### Readme Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `readme.path` | Path to the Readme in the book |
-
-### Glossary Variables
-
-| Variable | Description |
-| -------- | ----------- |
-| `glossary.path` | Path to the Glossary in the book |

docs/themes/README.md

@@ -1,39 +0,0 @@
-# Theming
-
-Since version 3.0.0, GitBook can be easily themed. Books use the [theme-default](https://github.com/GitbookIO/theme-default) theme by default.
-
-> **Caution**: Custom theming can block some plugins from working correctly.
-
-### Structure of a theme
-
-A theme is a plugin containing templates and assets. Overriding any individual template is optional, since themes always extend the default theme.
-
-| Folder | Description |
-| -------- | ----------- |
-| `_layouts` | Main folder containing all the templates |
-| `_layouts/website/page.html` | Template for a normal page |
-| `_layouts/ebook/page.html` | Template for a normal page during ebook generation (PDF, ePub, Mobi) |
-
-
-### Extend/Customize theme in a book
-
-Authors can extend the templates of a theme directly from their book's source (without creating an external theme). Templates will be resolved in the `_layouts` folder of the book first, then in the installed plugins/themes.
-
-### Extend instead of Forking
-
-When you want to make your theme changes available to multiple books, instead of forking the default theme, you can extend it using the [templating syntax](../templating/README.md):
-
-```html
-{% extends template.self %}
-
-{% block body %}
-    {{ super() }}
-    ... This will be added to the "body" block
-{% endblock %}
-```
-
-Take a look at the [API](https://github.com/GitbookIO/theme-api) theme for a more complete example.
-
-### Publish a theme
-
-Themes are published as plugins ([see related docs](../plugins/README.md)) with a `theme-` prefix. For example the theme `awesome` will be loaded from the `theme-awesome` plugin, and then from the `gitbook-plugin-theme-awesome` NPM package.

lerna.json

@@ -1,4 +0,0 @@
-{
-  "lerna": "2.0.0-beta.31",
-  "version": "4.0.0-alpha.2"
-}

package.json

@@ -1,26 +1,73 @@
 {
-  "private": true,
-  "devDependencies": {
-    "eslint": "3.12.2",
-    "eslint-config-gitbook": "1.5.0",
-    "lerna": "2.0.0-beta.31"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "test": "lerna run --concurrency 1 test",
-    "bootstrap": "npm run bump && lerna bootstrap",
-    "bump": "./scripts/bump.js",
-    "clean": "lerna clean",
-    "dist": "lerna run --concurrency 1 prepublish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/GitbookIO/gitbook.git"
-  },
-  "author": "GitBook Inc. <contact@gitbook.com>",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/GitbookIO/gitbook/issues"
-  },
-  "homepage": "https://github.com/GitbookIO/gitbook#readme"
+    "name": "gitbook",
+    "version": "0.1.0",
+    "engines": {
+        "node": "^22.3.0"
+    },
+    "devDependencies": {
+        "@changesets/cli": "^2.31.1",
+        "oxfmt": "^0.62.0",
+        "oxlint": "^1.90.0",
+        "turbo": "^2.11.10",
+        "vercel": "50.37.3"
+    },
+    "packageManager": "bun@1.3.7",
+    "overrides": {
+        "@codemirror/state": "6.4.1",
+        "@types/react": "catalog:",
+        "@types/react-dom": "catalog:",
+        "react": "catalog:",
+        "react-dom": "catalog:",
+        "esbuild": "0.27.3",
+        "axios": "1.8.4"
+    },
+    "private": true,
+    "scripts": {
+        "dev": "turbo run dev --concurrency 20",
+        "build": "turbo run build",
+        "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
+        "typecheck": "turbo run typecheck",
+        "lint": "oxlint --quiet",
+        "lint:fix": "oxlint --fix --quiet",
+        "format": "oxfmt",
+        "format:check": "oxfmt --check",
+        "unit": "turbo run unit",
+        "e2e": "turbo run e2e",
+        "e2e-customers": "turbo run e2e-customers",
+        "changeset": "changeset",
+        "changeset-version": "changeset version && bun run format && bun update",
+        "publish-all-packages": "turbo run publish-to-npm --continue=dependencies-successful",
+        "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
+        "clean": "turbo run clean"
+    },
+    "workspaces": {
+        "packages": [
+            "packages/*"
+        ],
+        "catalog": {
+            "@tsconfig/strictest": "^2.0.6",
+            "@tsconfig/node20": "^20.1.6",
+            "@base-ui/react": "^1.7.0",
+            "@gitbook/api": "0.208.0",
+            "@scalar/api-client-react": "^1.3.46",
+            "@types/react": "^19.0.0",
+            "@types/react-dom": "^19.0.0",
+            "assert-never": "^1.4.0",
+            "bidc": "^0.0.2",
+            "bun-types": "^1.1.20",
+            "classnames": "^2.5.1",
+            "react": "^19.0.1",
+            "react-dom": "^19.0.1",
+            "tsdown": "^0.15.6",
+            "typescript": "^5.5.3",
+            "usehooks-ts": "^3.1.1",
+            "vercel": "^50.26.1"
+        }
+    },
+    "patchedDependencies": {
+        "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
+        "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch",
+        "next@16.4.3": "patches/next@16.4.3.patch",
+        "mermaid@11.16.1": "patches/mermaid@11.16.1.patch"
+    }
 }

packages/browser-types/.gitignore

@@ -0,0 +1 @@
+dist/

packages/browser-types/CHANGELOG.md

@@ -0,0 +1,58 @@
+# @gitbook/browser-types
+
+## 0.1.6
+
+### Patch Changes
+
+- bf674a4: Add an optional `context` property (string, up to 512 characters) to the `confirmation` of custom AI tools, shown above the confirmation dialog to help the user understand what they are approving or rejecting. The `confirmation` can now also be a function that receives the AI-provided input and returns the confirmation, so the context can be derived dynamically from the arguments the tool is about to run with. Available both to integrations (`GitBookIntegrationTool`) and to embed consumers (`GitBookToolDefinition`).
+
+## 0.1.5
+
+### Patch Changes
+
+- 5f66860: Use isCookiesTrackingDisabled for cookie consent integrations
+- 2e495cb: Add Global Privacy Control (GPC) support
+
+## 0.1.4
+
+### Patch Changes
+
+- 7a11861: Add support for custom cookie banner registration
+- Updated dependencies [6f1db32]
+  - @gitbook/icons@0.4.3
+
+## 0.1.3
+
+### Patch Changes
+
+- 10995e0: Use NPM Trusted publishing for publishing the package.
+- Updated dependencies [10995e0]
+  - @gitbook/icons@0.3.4
+
+## 0.1.2
+
+### Patch Changes
+
+- 6142d6b: Mark as sideEffects, fix all package bundles
+- Updated dependencies [6142d6b]
+  - @gitbook/icons@0.3.3
+
+## 0.1.1
+
+### Patch Changes
+
+- 295f03d: Republish packages
+- Updated dependencies [295f03d]
+  - @gitbook/icons@0.3.2
+
+## 0.1.0
+
+### Minor Changes
+
+- cbc71a5: First version of the public package for typing script integrations.
+
+### Patch Changes
+
+- 854c448: Custom assistants followup
+- Updated dependencies [25e2b40]
+  - @gitbook/icons@0.3.0