Version Packages (#2907)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.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/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": []
+}

.editorconfig

@@ -1,10 +0,0 @@
-# editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

.eslintignore

@@ -1 +0,0 @@
-theme/**/*

.eslintrc

@@ -1,19 +0,0 @@
-{
-    "rules": {
-        "indent": [ 2, 4 ],
-        "quotes": [ 2, "single" ],
-        "linebreak-style": [ 2, "unix" ],
-        "semi": [ 2, "always" ],
-        "no-unused-vars": [ 2, {
-            "vars": "all",
-            "args": "none"
-        } ],
-        "spaced-comment": [ 2, "always" ]
-    },
-    "env": {
-        "node": true,
-        "mocha": true,
-        "browser": true
-    },
-    "extends": "eslint:recommended"
-}

.github/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Welcome to GitBook's contributing guide!
+
+> _For help, support, feature requests, and product questions - head to our [GitHub Community](https://github.com/orgs/GitbookIO/discussions) 🤖_
+
+Thank you for investing your time in contributing to GitBook. Any contribution you make will be reviewed by our team. In this guide, you'll learn the different ways you can contribute.
+
+## Types of Contributions
+
+This repository contains code related to the rendering engine of GitBook's published content. Depending on what you'd like to contribute to, head to the section below to find the necessary steps.
+
+### Add a feature
+
+Because this portion of GitBook is open source and available for you to use - if you think you can provide extra value through a new feature - you're welcome to add it! If you plan to distribute the code, keep the source code public to comply with GNU GPLv3. To clone in a private repository, you must first acquire a [commercial license](https://www.gitbook.com/pricing).
+
+### Create a new issue
+
+If you spot a problem within a repository, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue here!Please make sure any added issues are
+
+-   Descriptive
+-   Thoughtful
+-   Organized
+
+We recommend adding as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast.
+
+### Solve an issue
+
+If you're interested in solving an issue in our repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix. See the following sections below for more information on contributing for specific sections.
+
+### Documentation
+
+The official documentation on GitBook open can be found directly in this Readme. Any updates or changes you would like to make, you can make directly to the README of this repository.
+
+## Contributing
+
+### Make changes locally
+
+Any contribution you make can be made to the code located in this repository. In order to contribute, you'll need to start off of a local version of this repository.
+
+#### 1. Fork the repository
+
+##### Using GitHub Desktop:
+
+-   [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
+-   Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
+
+##### Using the command line:
+
+-   [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
+
+#### 2. Create a working branch and start with your changes
+
+After forking this repository, you'll want to [create a branch](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-a-branch-for-an-issue) to work off of.
+
+#### 3. Install dependencies and run the project locally
+
+GitBook uses [Bun](https://bun.sh/) to run the project. Make sure you're using the specified version of `node` before running any of the development commands to ensure a smooth development experience.
+
+You can easily do this by running the command `nvm use`.
+
+To start your local version of GitBook, run the command `bun dev`.
+
+#### 4. Preview your changes
+
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
+
+For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/docs.gitbook.com` after running the development server.
+
+You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://docs.gitbook.com/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
+
+### Commit your update
+
+[Commit your changes](https://github.com/git-guides/git-commit) once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages!
+
+Once your changes are ready, don't forget to self-review your code to double check that your chagnes are ready to be added.
+
+### Pull Request
+
+When you're finished with the changes, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), also known as a PR.
+
+-   Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
+-   Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. Once you submit your PR, a GitBook team member will review your proposal. We may ask questions or request for additional information.
+-   We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+-   As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+-   If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is merged
+
+Congratulations 🎉 Thank you for your contribution! Once your PR is merged, your contributions will be publicly visible on the relevant repository.

.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/setup-playwright/action.yml

@@ -0,0 +1,37 @@
+name: 'Setup Playwright'
+description: 'Install Playwright and dependencies'
+runs:
+    using: 'composite'
+    steps:
+        # Run npm ci and get Playwright version
+        - name: 🏗 Prepare Playwright env
+          shell: bash
+          run: |
+              PLAYWRIGHT_VERSION=$(npm ls --json @playwright/test | jq --raw-output '.dependencies["gitbook"].dependencies["@playwright/test"].version')
+              echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
+
+        # Cache browser binaries, cache key is based on Playwright version and OS
+        - name: 🧰 Cache Playwright browser binaries
+          uses: actions/cache@v4
+          id: playwright-cache
+          with:
+              path: '~/.cache/ms-playwright'
+              key: '${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}'
+              restore-keys: |
+                  ${{ runner.os }}-playwright-
+
+        # Install browser binaries & OS dependencies if cache missed
+        - name: 🏗 Install Playwright browser binaries & OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit != 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install --with-deps chromium
+
+        # Install only the OS dependencies if cache hit
+        - name: 🏗 Install Playwright OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit == 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install-deps

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

@@ -0,0 +1,58 @@
+name: 'Deploy vercel'
+description: 'Deploy GitBook to Vercel'
+inputs:
+  vercel-org:
+    description: 'Vercel organization'
+    required: true
+  vercel-project:
+    description: 'Vercel project'
+    required: true
+  vercel-token:
+    description: 'Vercel token'
+    required: true
+  environment:
+    description: 'Environment to deploy to'
+    required: true
+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: Sets env vars for environment
+          shell: bash
+          run: |
+              echo "VERCEL_ENVIRONMENT=${{ inputs.environment }}" >> $GITHUB_ENV
+        - name: Pull Vercel Environment Information
+          run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+        - name: Build Project Artifacts
+          run: bun run vercel build --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+        - name: Deploy Project Artifacts to Vercel
+          id: deploy
+          shell: bash
+          run: |
+              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }})
+              echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+        - name: Outputs
+          shell: bash
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

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

@@ -0,0 +1,18 @@
+name: 'Setup Bun'
+description: 'Install Bun and cache dependencies'
+runs:
+    using: 'composite'
+    steps:
+        # We cache dependencies even if Bun is fast to avoid downloading fontawesome too many times
+        # and impacting bandwidth there.
+        - name: Cache bun
+          uses: actions/cache@v4
+          with:
+              path: ~/.bun/install/cache
+              key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/bun.lock') }}
+              restore-keys: |
+                  ${{ runner.os }}-bun-
+        - name: Setup bun
+          uses: oven-sh/setup-bun@v2
+          with:
+              bun-version-file: 'package.json'

.github/workflows/ci.yaml

@@ -0,0 +1,378 @@
+name: CI
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy:
+        name: Deploy to Cloudflare Pages
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
+        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: Sets env vars for production
+              run: |
+                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+              if: startsWith(github.ref, 'refs/heads/main')
+            - name: Sets env vars for preview
+              run: |
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+              if: 1 && !startsWith(github.ref, 'refs/heads/main')
+            - name: Build Next.js with next-on-pages
+              run: bun run turbo gitbook#build:cloudflare
+              env:
+                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+                  SENTRY_RELEASE: ${{ github.sha }}
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.82.0'
+                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
+            - name: Archive build output
+              uses: actions/upload-artifact@v4
+              with:
+                  name: build-output
+                  path: .vercel/
+            # Until https://github.com/cloudflare/wrangler-action/issues/301 is done
+            - name: Update Deployment Status to Success
+              env:
+                  DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+              run: |
+                  curl -X POST \
+                    -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+                    -H "Accept: application/vnd.github.v3+json" \
+                    -d '{"state": "success", "target_url": "${{ steps.deploy.outputs.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
+                    https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
+                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
+                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
+    deploy-v2-vercel-staging:
+        name: Deploy v2 to Vercel (staging)
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        if: startsWith(github.ref, 'refs/heads/main')
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy staging
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: staging
+                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
+                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        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: Sets env vars for production
+              run: |
+                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                  echo "GITBOOK_URL=https://open-2c.gitbook.com" >> $GITHUB_ENV
+                  echo "GITBOOK_ASSETS_PREFIX=https://static-2c.gitbook.com" >> $GITHUB_ENV
+              if: startsWith(github.ref, 'refs/heads/main')
+            - name: Sets env vars for preview
+              run: |
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+              if: 1 && !startsWith(github.ref, 'refs/heads/main')
+            - name: Build worker
+              run: bun run turbo build:v2:cloudflare
+              env:
+                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
+                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
+                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
+                  SENTRY_RELEASE: ${{ github.sha }}
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.82.0'
+                  command: versions upload --config ./packages/gitbook-v2/wrangler.toml
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+    comment-deployments:
+        runs-on: ubuntu-latest
+        name: Comment Deployments
+        if: always() && !startsWith(github.ref, 'refs/heads/main')
+        needs:
+            - deploy
+            - 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 1 (production)
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Latest commit | [${{ needs.deploy.outputs.deployment-url }}](${{ needs.deploy.outputs.deployment-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
+                      | PR | [${{ needs.deploy.outputs.deployment-alias-url }}](${{ needs.deploy.outputs.deployment-alias-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
+
+                      ### Version 2 (experimental)
+
+                      | 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 | v1 | v2 |
+                      | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) |
+                      | E2E | [${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ 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) |
+                  edit-mode: replace
+    visual-testing:
+        runs-on: ubuntu-latest
+        name: Visual Testing
+        needs: deploy
+        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
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+    visual-testing-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2
+        needs: deploy-v2-vercel
+        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
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'v2'
+    visual-testing-customers:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers
+        needs: deploy
+        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
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers'
+    visual-testing-customers-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2
+        needs: deploy-v2-vercel
+        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
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v2'
+    pagespeed-testing:
+        runs-on: ubuntu-latest
+        name: PageSpeed Testing
+        needs: deploy
+        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 pagespeed tests
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
+              env:
+                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
+                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
+    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
+    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-oss:
+        # CI to check that the repository builds correctly on a machine without the credentials
+        runs-on: ubuntu-latest
+        name: Build (Open Source)
+        timeout-minutes: 6
+        env:
+            NPM_TOKEN_READONLY: ''
+        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/publish.yaml

@@ -0,0 +1,57 @@
+name: Publish
+
+on:
+    push:
+        branches:
+            - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+    publish:
+        name: Publish
+        runs-on: ubuntu-latest
+        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 Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Create Release Pull Request or Publish to npm
+              id: changesets
+              uses: changesets/action@v1
+              with:
+                  publish: npm run release
+                  version: npm 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 }}
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+    release-preview:
+        # For now it releases the cache-do to both preview and production
+        # Once we changed to deploy the app only on release, we should change `release:preview` in `cache-do`
+        name: Release Preview
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v3
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Release preview packages
+              run: bun run release:preview
+              env:
+                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}

.gitignore

@@ -1,28 +1,27 @@
-# 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
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Env files
+.env.local
+
+# TypeScript
+*.tsbuildinfo

.nvmrc

@@ -0,0 +1 @@
+v20.6

.prettierignore

@@ -0,0 +1,17 @@
+.next
+.vercel
+.open-next
+
+# Generated
+packages/emoji-codepoints/index.ts
+packages/gitbook/public/~gitbook/static/
+packages/icons/src/data/*.json
+
+# Build files
+dist/
+
+README.md
+CHANGELOG.md
+
+# v2
+packages/gitbook-v2/public/~gitbook/static/

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+    "printWidth": 100,
+    "singleQuote": true,
+    "tabWidth": 4
+}

.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: node_js
-node_js:
-  - "stable"
-  - "4.1"
-  - "0.12"
-before_install:
-  - npm install svgexport -g

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "tailwindCSS.experimental.classRegex": [
+        ["Style \\=([^;]*);", "'([^']*)'"],
+        ["Style \\=([^;]*);", "\"([^\"]*)\""],
+        ["Style \\=([^;]*);", "\\`([^\\`]*)\\`"],
+        ["style \\=([^;]*);", "'([^']*)'"],
+        ["style \\=([^;]*);", "\"([^\"]*)\""],
+        ["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
+    ],
+    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
+    "prettier.enable": false,
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.codeActionsOnSave": {
+        "source.organizeImports": "explicit"
+    }
+}

AUTHORS.md

@@ -1,63 +0,0 @@
-Authors
-=======
-
-Also see https://github.com/GitbookIO/gitbook/graphs/contributors.
-Names below are ordered by first contribution.
-
-Author
-------
-
-- Samy Pessé <samypesse@gmail.com> (@SamyPesse)
-- Aaron O'Mullan <aaron.omullan@gmail.com> (@AaronO)
-
-
-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)

CHANGES.md

@@ -1,311 +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/).
-
-## 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

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,230 +1,181 @@
-GitBook
-=======
+<h1 align="center">GitBook</h1>
 
-[![NPM version](https://badge.fury.io/js/gitbook.svg)](http://badge.fury.io/js/gitbook)
-[![Linux Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
-[![Windows Build status](https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true)](https://ci.appveyor.com/project/GitBook/gitbook)
-[![Slack Status](https://slack.gitbook.com/badge.svg)](https://slack.gitbook.com)
+<p align="center">
+  <a href="https://docs.gitbook.com/">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> 
+</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: [Learn Javascript](https://www.gitbook.com/book/GitBookIO/javascript).
+<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>
 
-You can publish and host book easily online using [gitbook.com](https://www.gitbook.com), a desktop editor is [also available](https://www.gitbook.com/editor).
+<p align="center">Welcome to GitBook, the platform for managing technical knowledge for teams.</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">This repository contains the open source code used to render GitBook's published content.</p>
 
-Complete documentation is available at [help.gitbook.com](http://help.gitbook.com/).
+<p align="center">
+  <img alt="GitBook Open Published Site" src="./assets/published-site.png">
+</p>
 
-![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
+## Table of Contents
 
-## How to use it:
+-   [Getting Started](#getting-started)
+-   [Contributing](#contributing)
+    -   [Types of contributions](#types-of-contributions)
+-   [Licensing](#license)
+-   [Acknowledgements](#acknowledgements)
+-   [Legacy GitBook](#legacy-gitbook-deprecated)
 
-GitBook can be installed from **NPM** using:
+## Getting Started
+
+To run a local version of this project, please follow these simple steps.
+
+### Prerequisites
+
+-   Node.js (Version: >=20.6)
+  - Use nvm for easy Node management
+-   Bun (Version: >=1.2.1)
+  - We use a text-based lockfile which isn't supported below 1.2.1
+
+### Set up
+
+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).
 
 ```
-$ npm install gitbook-cli -g
+git clone https://github.com/gitbookIO/gitbook.git
 ```
 
-Create the directories and files for a book from its [SUMMARY.md](https://github.com/GitbookIO/gitbook#book-format) file (if existing) using
+2. Ensure you are using the project's version of `node`. Running `nvm use` will change your local version to the correct one.
+
+3. Install the project's dependencies through Bun.
 
 ```
-$ gitbook init
+bun install
 ```
 
-You can serve a repository as a book using:
+4. Start your local development server.
 
 ```
-$ gitbook serve
+bun dev
 ```
 
-Or simply build the static website using:
+5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
+
+examples:
+
+-   http://localhost:3000/docs.gitbook.com
+-   http://localhost:3000/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.
+
+### Other development commands
+
+-   `bun format`: format the code
+-   `bun lint`: lint the code
+
+### 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. During development, your local environment will use the free version. However, only the pro version will be accepted by CI. If you see the following error:
 
 ```
-$ gitbook build
+The GitBook icon is missing. It indicates that the dependencies were installed without the correct font-awesome package. These changes have probably been persisted in the Bun lockfile. Read the README for more information.
 ```
 
-## Features
+It means that you've changed the GBO dependencies and bundled in the free version. Only GitBook staff can help with this - if you're not on the GitBook team, please ping us in the PR and we'll help get things moving.
 
-* [Output as a website or ebook (pdf, epub, mobi)](http://help.gitbook.com/format/output.html)
-* [Multi-Languages](http://help.gitbook.com/format/languages.html)
-* [Glossary](http://help.gitbook.com/format/glossary.html)
-* [Cover](http://help.gitbook.com/format/cover.html)
-* [AsciiDoc Support](http://help.gitbook.com/format/asciidoc.html)
-* [Variables and Templating](http://help.gitbook.com/format/templating.html)
-* [Content References](http://help.gitbook.com/format/conrefs.html)
-* [Plugins](http://help.gitbook.com/format/plugins.html)
-* Interractive reader website:
-    * Search
-    * Font Settings (Serif, Sans Serif)
-    * Themes: white, sepia, night
-
-## Output Formats
-
-GitBook can generate your book in the following formats:
-
-* **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
-* **eBook**: You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.  You can specify the eBook filename as the second argument, otherwise `book` will be used.
-  * Generate a **PDF** using:  `gitbook pdf ./myrepo ./mybook.pdf`
-  * Generate a **ePub** using: `gitbook epub ./myrepo ./mybook.epub`
-  * Generate a **MOBI** using: `gitbook mobi ./myrepo ./mybook.mobi`
-* **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo --format=json```.
-
-## Book Format
-
-A book is a Git repository containing at least 2 files: `README.md` and `SUMMARY.md`.
-
-#### README.md
-
-Typically, this should be the introduction for your book. It will be automatically added to the final summary.
-
-#### SUMMARY.md
-
-The `SUMMARY.md` defines your book's structure. It should contain a list of chapters, linking to their respective pages.
-
-Example:
-
-```markdown
-# Summary
-
-This is the summary of my book.
-
-* [section 1](section1/README.md)
-    * [example 1](section1/example1.md)
-    * [example 2](section1/example2.md)
-* [section 2](section2/README.md)
-    * [example 1](section2/example1.md)
-```
-
-Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
-
-#### 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
-* [English](en/)
-* [French](fr/)
-* [Español](es/)
-```
-
-You can see a complete example with the [Learn Git](https://github.com/GitbookIO/git) book.
-
-#### Glossary
-
-Allows you to specify terms and their respective definitions to be displayed in the glossary. Based on those terms, `gitbook` will automatically build an index and highlight those terms in pages.
-
-The `GLOSSARY.md` format is very simple :
-
-```markdown
-# term
-Definition for this term
-
-# Another term
-With it's definition, this can contain bold text and all other kinds of inline markup ...
-```
-
-#### Variables and Templating
-
-A set of variables can be defined in the `book.json`:
-
-```js
-{
-    "variables": {
-        "host": "mybook.com"
-    }
-}
-```
-
-These variables can be used in the markdown files:
+If you are GitBook staff, you'll need our NPM token in your local environment.
 
 ```
-The host is {{ book.host }}
+.env.local
+
+NPM_TOKEN_READONLY=xxx
 ```
 
-You can also use condition with these variables:
+and then reinstall dependencies.
 
-```
-{% if book.host == "mybook.com" %}
+## Contributing
 
-{% else %}
+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 more about the workflow on adding your first Pull Request.
 
-{% endif %}
+### 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/). We welcome all additional translations for the UI.
+
+#### Bugs
+
+Encounter a bug or find an issue you'd like to fix? Helping us fix issues related to GitBook greatly improves the experience for everyone. Head to the issues section of this repository to learn more about the types of bugs you can already help out with.
+
+## 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 to add a specific feature in GitBook? Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to get started._
+>
+> 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 contribute to our product directly 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://gitbook.com/)
 ```
 
-Variables of `book.json` are available in the `book` namespace. You can also access informations about the `file` itself and the `gitbook` version:
-
-```
-My file is {{ file.path }}
-Modified at {{ file.mtime }}
-Book built with GitBook {{ gitbook.version }}
+```html
+<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>
 ```
 
-#### Content References
+## Acknowledgements
 
-You can use "content references," or conrefs, when writing books or documentation using GitBook.
+GitBook wouldn't be possible without these projects:
 
-Include a file from the same book:
+-   [Next.js](https://nextjs.org/)
+-   [Bun](https://bun.sh/)
+-   [Tailwind CSS](https://tailwindcss.com/)
+-   [Framer Motion](https://www.npmjs.com/package/framer-motion)
 
-```
-{% include "./test.md" %}
-```
+## Contributors
 
-or from a git repository (with a specific revision):
+<a href="https://github.com/gitbookIO/gitbook/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=gitbookIO/gitbook" />
+</a>
 
-```
-{% include "git+https://github.com/GitbookIO/documentation.git/README.md#1.0.1" %}
-```
+## Legacy GitBook (Deprecated)
 
-Includes can be used with variables (see [Variables and Templating](#variables-and-templating)):
-
-```
-{% include book.ref_doc_readme %}
-```
-
-#### Ignoring files & folders
-
-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`).
-
-Best practices for the `.gitignore` is to ignore build files from **node.js** (`node_modules`, ...) and build files from GitBook: `_book`, `*.epub`, `*.mobi` and `*.pdf` ([Download GitBook.gitignore](https://github.com/github/gitignore/blob/master/GitBook.gitignore)).
-
-#### Cover
-
-A cover image can be set by creating a file: **/cover.jpg**.
-The best resolution is **1800x2360**. The generation of the cover can be done automatically using the plugin [autocover](https://github.com/GitbookIO/plugin-autocover).
-
-A small version of the cover can also be set by creating a file: **/cover_small.jpg**.
-
-#### AsciiDoc
-
-Since version 2.0.0, AsciiDoc can be used instead of Markdown, simply replace the `.md` by the `.adoc` extension. Chapters in the summary are detected from an ordered list in the `SUMMARY.adoc`.
-
-## Publish your book
-
-The platform [GitBook.com](https://www.gitbook.com/) is like an "Heroku for books": you can create a book on it (public, paid, or private) and update it using **git push**.
-
-## Plugins
-
-Plugins can be used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
-
-Plugins needed to build a book can be installed using: `gitbook install ./`. You can find plugins at [plugins.gitbook.com](http://plugins.gitbook.com).
-
-
-## 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
-```
-
-#### How to use the latest commit from GitBook in gitbook-cli
-
-To use the latest commit from `GitBook/gitbook` with `gitbook-cli`:
-
-```
-$ git clone https://github.com/GitbookIO/gitbook.git ./gitbook
-$ gitbook versions:link ./gitbook
-```
-
-Now `gitbook-cli` will be using the `./gitbook` folder.
-
-You can uninstall it using: `gitbook versions:uninstall latest`.
+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,29 +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: "0.12"
-    - nodejs_version: "4.1"
-
-# 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
-  # 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

bin/gitbook.js

@@ -1,7 +0,0 @@
-#! /usr/bin/env node
-
-var color = require('bash-color');
-
-console.log(color.red('You need to install "gitbook-cli" to have access to the gitbook command anywhere on your system.'));
-console.log(color.red('If you\'ve installed this package globally, you need to uninstall it.'));
-console.log(color.red('>> Run "npm uninstall -g gitbook" then "npm install -g gitbook-cli"'));

biome.json

@@ -0,0 +1,168 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "vcs": {
+        "enabled": false,
+        "clientKind": "git",
+        "useIgnoreFile": false
+    },
+    "files": {
+        "ignoreUnknown": false,
+        "ignore": [
+            "**/node_modules/**/*",
+            "**/dist/**/*",
+            "**/build/**/*",
+            "**/public/**/*",
+            "**/.next/**/*",
+            "**/.open-next/**/*",
+            "**/.turbo/**/*",
+            "**/.vercel/**/*",
+            "**/.cache/**/*",
+            "**/.wrangler/**/*",
+            "packages/openapi-parser/src/fixtures/**/*"
+        ]
+    },
+    "formatter": {
+        "enabled": true,
+        "useEditorconfig": true,
+        "formatWithErrors": false,
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "lf",
+        "lineWidth": 100,
+        "attributePosition": "auto",
+        "bracketSpacing": true
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true,
+            "performance": {
+                "noDelete": "warn"
+            },
+            "security": {
+                "noDangerouslySetInnerHtml": "off"
+            },
+            "complexity": {
+                "noForEach": "off",
+                "noUselessFragments": "warn",
+                "noBannedTypes": "warn"
+            },
+            "correctness": {
+                "noUndeclaredVariables": "error",
+                "noUnusedVariables": "error",
+                "useArrayLiterals": "error",
+                "useHookAtTopLevel": "error",
+                "noUnusedImports": "error",
+                "noVoidElementsWithChildren": "warn",
+                "useJsxKeyInIterable": "warn",
+                "useExhaustiveDependencies": "warn",
+                "noUnknownFunction": "warn"
+            },
+            "style": {
+                "noNonNullAssertion": "warn",
+                "noParameterAssign": "off",
+                "useThrowOnlyError": "error"
+            },
+            "suspicious": {
+                "noConsole": "warn",
+                "noExplicitAny": "warn",
+                "noImplicitAnyLet": "warn",
+                "noConfusingVoidType": "warn",
+                "noControlCharactersInRegex": "warn",
+                "noPrototypeBuiltins": "warn",
+                "noAssignInExpressions": "warn",
+                "noArrayIndexKey": "warn"
+            },
+            "a11y": {
+                "useSemanticElements": "warn",
+                "useKeyWithClickEvents": "warn",
+                "noSvgWithoutTitle": "warn",
+                "useButtonType": "warn",
+                "useIframeTitle": "warn",
+                "useAltText": "warn",
+                "noPositiveTabindex": "warn",
+                "useFocusableInteractive": "warn",
+                "useAriaPropsForRole": "warn",
+                "useValidAnchor": "warn",
+                "noLabelWithoutControl": "warn",
+                "noNoninteractiveTabindex": "warn"
+            },
+            "nursery": {
+                "useSortedClasses": {
+                    "level": "error",
+                    "fix": "safe",
+                    "options": {
+                        "attributes": ["class", "className", "style"],
+                        "functions": ["clsx", "tw"]
+                    }
+                }
+            }
+        }
+    },
+    "javascript": {
+        "formatter": {
+            "jsxQuoteStyle": "double",
+            "quoteProperties": "asNeeded",
+            "trailingCommas": "es5",
+            "semicolons": "always",
+            "arrowParentheses": "always",
+            "bracketSameLine": false,
+            "quoteStyle": "single",
+            "attributePosition": "auto",
+            "bracketSpacing": true
+        }
+    },
+    "overrides": [
+        {
+            "include": [
+                "packages/gitbook/**/*",
+                "packages/gitbook-v2/**/*",
+                "packages/react-openapi/**/*",
+                "packages/react-math/**/*",
+                "packages/react-contentkit/**/*",
+                "packages/icons/**/*"
+            ],
+            "javascript": {
+                "globals": ["React"]
+            }
+        },
+        {
+            "include": ["packages/gitbook/**/*"],
+            "javascript": {
+                "globals": ["React", "GitBookIntegrationEvent"]
+            }
+        },
+        {
+            "include": ["*.css"],
+            "javascript": {
+                "globals": ["theme"]
+            }
+        },
+        {
+            "include": ["*.test.ts", "packages/gitbook/tests/**/*"],
+            "javascript": {
+                "globals": ["Bun"]
+            }
+        },
+        {
+            "include": [
+                "packages/cache-do/**/*",
+                "packages/gitbook/cf-env.d.ts",
+                "packages/gitbook/src/cloudflare-entrypoint.ts"
+            ],
+            "javascript": {
+                "globals": [
+                    "DurableObjectLocationHint",
+                    "DurableObjectNamespace",
+                    "DurableObjectStub",
+                    "ContinentCode",
+                    "Fetcher",
+                    "ExportedHandler"
+                ]
+            }
+        }
+    ]
+}

bunfig.toml

@@ -0,0 +1,2 @@
+[install.scopes]
+"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }

gulpfile.js

@@ -1,47 +0,0 @@
-var _ = require('lodash');
-var gulp = require('gulp');
-var gutil = require('gulp-util');
-var less = require('gulp-less');
-var rename = require('gulp-rename');
-var minifyCSS = require('gulp-minify-css');
-var browserify = require('browserify');
-var mergeStream = require('merge-stream');
-var source = require('vinyl-source-stream');
-
-gulp.task('css', function() {
-    var merged = mergeStream();
-
-    _.each({
-        'ebook.less': 'ebook/ebook.css',
-        'pdf.less': 'ebook/pdf.css',
-        'mobi.less': 'ebook/mobi.css',
-        'epub.less': 'ebook/epub.css',
-        'website.less': 'website/style.css'
-    }, function(out, input) {
-        gutil.log('compiling', input, 'into', out);
-        merged.add(gulp.src('theme/stylesheets/'+input)
-            .pipe(less())
-            .pipe(minifyCSS())
-            .pipe(rename(out))
-            .pipe(gulp.dest('theme/assets/')));
-    });
-
-    return merged;
-});
-
-gulp.task('js', function() {
-    return browserify('./theme/javascript/index.js')
-        .bundle()
-        .pipe(source('app.js'))
-        .pipe(gulp.dest('./theme/assets/website'));
-});
-
-gulp.task('assets', function() {
-    return gulp.src('./node_modules/font-awesome/fonts/*')
-    .pipe(gulp.dest('theme/assets/website/fonts/fontawesome/'));
-});
-
-gulp.task('default', ['css', 'js', 'assets'], function() {
-
-});
-

lib/blocks.js

@@ -1,11 +0,0 @@
-var _ = require('lodash');
-
-module.exports = {
-    // Return non-parsed html
-    // since blocks are by default non-parsable, a simple identity method works fine
-    html: _.identity,
-
-    // Highlight a code block
-    // This block can be extent by plugins
-    code: _.identity
-};

lib/book.js

@@ -1,817 +0,0 @@
-var Q = require('q');
-var _ = require('lodash');
-var path = require('path');
-var parsers = require('gitbook-parsers');
-
-var fs = require('./utils/fs');
-var parseNavigation = require('./utils/navigation');
-var parseProgress = require('./utils/progress');
-var pageUtil = require('./utils/page');
-var pathUtil = require('./utils/path');
-var links = require('./utils/links');
-var i18n = require('./utils/i18n');
-var logger = require('./utils/logger');
-
-var Configuration = require('./configuration');
-var TemplateEngine = require('./template');
-var PluginsList = require('./pluginslist');
-
-var generators = require('./generators');
-
-var Book = function(root, context, parent) {
-    this.context = _.defaults(context || {}, {
-        // Extend book configuration
-        config: {},
-
-        // Log function
-        log: function(msg) {
-            process.stdout.write(msg);
-        },
-
-        // Log level
-        logLevel: 'info'
-    });
-
-    // Log
-    this.log = logger(this.context.log, this.context.logLevel);
-
-    // Root folder of the book
-    this.root = path.resolve(root);
-
-    // Parent book
-    this.parent = parent;
-
-    // Configuration
-    this.config = new Configuration(this, this.context.config);
-    Object.defineProperty(this, 'options', {
-        get: function () {
-            return this.config.options;
-        }
-    });
-
-    // Template
-    this.template = new TemplateEngine(this);
-
-    // Summary
-    this.summary = {};
-    this.navigation = [];
-
-    // Glossary
-    this.glossary = [];
-
-    // Langs
-    this.langs = [];
-
-    // Sub-books
-    this.books = [];
-
-    // Files in the book
-    this.files = [];
-
-    // List of plugins
-    this.plugins = new PluginsList(this);
-
-    // Structure files
-    this.summaryFile = null;
-    this.glossaryFile = null;
-    this.readmeFile = null;
-    this.langsFile = null;
-
-    // Bind methods
-    _.bindAll(this);
-};
-
-// Return string representation
-Book.prototype.toString = function() {
-    return '[Book '+this.root+']';
-};
-
-// Initialize and parse the book: config, summary, glossary
-Book.prototype.parse = function() {
-    var that = this;
-    var multilingual = false;
-
-    return this.parseConfig()
-
-    .then(function() {
-        return that.parsePlugins();
-    })
-
-    .then(function() {
-        return that.parseLangs()
-        .then(function() {
-            multilingual = that.langs.length > 0;
-            if (multilingual) that.log.info.ln('Parsing multilingual book, with', that.langs.length, 'languages');
-
-            // Sub-books that inherit from the current book configuration
-            that.books = _.map(that.langs, function(lang) {
-                that.log.info.ln('Preparing language book', lang.lang);
-                return new Book(
-                    path.join(that.root, lang.path),
-                    _.merge({}, that.context, {
-                        config: _.extend({}, that.options, {
-                            'output': path.join(that.options.output, lang.lang),
-                            'language': lang.lang
-                        })
-                    }),
-                    that
-                );
-            });
-        });
-    })
-
-    .then(function() {
-        if (multilingual) return;
-        return that.listAllFiles();
-    })
-    .then(function() {
-        if (multilingual) return;
-        return that.parseReadme();
-    })
-    .then(function() {
-        if (multilingual) return;
-        return that.parseSummary();
-    })
-    .then(function() {
-        if (multilingual) return;
-        return that.parseGlossary();
-    })
-
-    .then(function() {
-        // Init sub-books
-        return _.reduce(that.books, function(prev, book) {
-            return prev.then(function() {
-                return book.parse();
-            });
-        }, Q());
-    })
-
-    .thenResolve(this);
-};
-
-// Generate the output
-Book.prototype.generate = function(generator) {
-    var that = this;
-    that.options.generator = generator || that.options.generator;
-
-    that.log.info.ln('start generation with', that.options.generator, 'generator');
-    return Q()
-
-    // Clean output folder
-    .then(function() {
-        that.log.info('clean', that.options.generator, 'generator');
-        return fs.clean(that.options.output)
-        .progress(function(p) {
-            that.log.debug.ln('remove', p.file, '('+p.i+'/'+p.count+')');
-        })
-        .then(function() {
-            that.log.info.ok();
-        });
-    })
-
-    // Create generator
-    .then(function() {
-        var Generator = generators[generator];
-        if (!Generator) throw 'Generator \''+that.options.generator+'\' doesn\'t exist';
-        generator = new Generator(that);
-
-        return generator.prepare();
-    })
-
-    // Transform configuration
-    .then(function() {
-        return that.callHook('config', that.config.dump())
-        .then(function(newConfig) {
-            that.config.replace(newConfig);
-        });
-    })
-
-    // Generate content
-    .then(function() {
-        if (that.isMultilingual()) {
-            return that.generateMultiLingual(generator);
-        } else {
-            // Separate list of files into the different operations needed
-            var ops = _.groupBy(that.files, function(file) {
-                if (file[file.length -1] == '/') {
-                    return 'directories';
-                } else if (_.contains(parsers.extensions, path.extname(file)) && that.navigation[file]) {
-                    return 'content';
-                } else {
-                    return 'files';
-                }
-            });
-
-
-            return Q()
-
-            // First, let's create folder
-            .then(function() {
-                return _.reduce(ops.directories || [], function(prev, folder) {
-                    return prev.then(function() {
-                        that.log.debug.ln('transferring folder', folder);
-                        return Q(generator.transferFolder(folder));
-                    });
-                }, Q());
-            })
-
-            // Then, let's copy other files
-            .then(function() {
-                return Q.all(_.map(ops.files || [], function(file) {
-                    that.log.debug.ln('transferring file', file);
-                    return Q(generator.transferFile(file));
-                }));
-            })
-
-            // Finally let's generate content
-            .then(function() {
-                var nFiles = (ops.content || []).length;
-                return _.reduce(ops.content || [], function(prev, file, i) {
-                    return prev.then(function() {
-                        var p = ((i*100)/nFiles).toFixed(0)+'%';
-                        that.log.debug.ln('processing', file, p);
-
-                        return Q(generator.convertFile(file))
-                        .fail(function(err) {
-                            // Transform error message to signal file
-                            throw that.normError(err, {
-                                fileName: file
-                            });
-                        });
-                    });
-                }, Q());
-            });
-        }
-    })
-
-    // Finish generation
-    .then(function() {
-        return that.callHook('finish:before');
-    })
-    .then(function() {
-        return generator.finish();
-    })
-    .then(function() {
-        return that.callHook('finish');
-    })
-    .then(function() {
-        that.log.info.ln('generation is finished');
-    });
-};
-
-// Generate the output for a multilingual book
-Book.prototype.generateMultiLingual = function() {
-    var that = this;
-
-    return Q()
-    .then(function() {
-        // Generate sub-books
-        return _.reduce(that.books, function(prev, book) {
-            return prev.then(function() {
-                return book.generate(that.options.generator);
-            });
-        }, Q());
-    });
-};
-
-// Extract files from ebook generated
-Book.prototype.generateFile = function(output, options) {
-    var book = this;
-
-    options = _.defaults(options || {}, {
-        ebookFormat: path.extname(output).slice(1)
-    });
-    output = output || path.resolve(book.root, 'book.'+options.ebookFormat);
-
-    return fs.tmp.dir()
-    .then(function(tmpDir) {
-        book.setOutput(tmpDir);
-
-        return book.generate(options.ebookFormat)
-        .then(function() {
-            var copyFile = function(lang) {
-                var _outputFile = output;
-                var _tmpDir = tmpDir;
-
-                if (lang) {
-                    _outputFile = _outputFile.slice(0, -path.extname(_outputFile).length)+'_'+lang+path.extname(_outputFile);
-                    _tmpDir = path.join(_tmpDir, lang);
-                }
-
-                book.log.debug.ln('copy ebook to', _outputFile);
-                return fs.copy(
-                    path.join(_tmpDir, 'index.'+options.ebookFormat),
-                    _outputFile
-                );
-            };
-
-            // Multi-langs book
-            return Q()
-            .then(function() {
-                if (book.isMultilingual()) {
-                    return Q.all(
-                        _.map(book.langs, function(lang) {
-                            return copyFile(lang.lang);
-                        })
-                    )
-                    .thenResolve(book.langs.length);
-                } else {
-                    return copyFile().thenResolve(1);
-                }
-            })
-            .then(function(n) {
-                book.log.info.ok(n+' file(s) generated');
-
-                return fs.remove(tmpDir);
-            });
-        });
-    });
-};
-
-// Parse configuration
-Book.prototype.parseConfig = function() {
-    var that = this;
-
-    that.log.info('loading book configuration....');
-    return that.config.load()
-    .then(function() {
-        that.log.info.ok();
-    });
-};
-
-// Parse list of plugins
-Book.prototype.parsePlugins = function() {
-    var that = this;
-
-    // Load plugins
-    return that.plugins.load(that.options.plugins)
-    .then(function() {
-        if (_.size(that.plugins.failed) > 0) return Q.reject(new Error('Error loading plugins: '+that.plugins.failed.join(',')+'. Run \'gitbook install\' to install plugins from NPM.'));
-
-        that.log.info.ok(that.plugins.count()+' plugins loaded');
-        that.log.debug.ln('normalize plugins list');
-    });
-};
-
-// Parse readme to extract defaults title and description
-Book.prototype.parseReadme = function() {
-    var that = this;
-    var filename = that.config.getStructure('readme', true);
-    that.log.debug.ln('start parsing readme:', filename);
-
-    return that.findFile(filename)
-    .then(function(readme) {
-        if (!readme) throw 'No README file';
-        if (!_.contains(that.files, readme.path)) throw 'README file is ignored';
-
-        that.readmeFile = readme.path;
-        that._defaultsStructure(that.readmeFile);
-
-        that.log.debug.ln('readme located at', that.readmeFile);
-        return that.template.renderFile(that.readmeFile)
-        .then(function(content) {
-            return readme.parser.readme(content)
-            .fail(function(err) {
-                throw that.normError(err, {
-                    name: err.name || 'Readme Parse Error',
-                    fileName: that.readmeFile
-                });
-            });
-        });
-    })
-    .then(function(readme) {
-        that.options.title = that.options.title || readme.title;
-        that.options.description = that.options.description || readme.description;
-    });
-};
-
-
-// Parse langs to extract list of sub-books
-Book.prototype.parseLangs = function() {
-    var that = this;
-
-    var filename = that.config.getStructure('langs', true);
-    that.log.debug.ln('start parsing languages index:', filename);
-
-    return that.findFile(filename)
-    .then(function(langs) {
-        if (!langs) return [];
-
-        that.langsFile = langs.path;
-        that._defaultsStructure(that.langsFile);
-
-        that.log.debug.ln('languages index located at', that.langsFile);
-        return that.template.renderFile(that.langsFile)
-        .then(function(content) {
-            return langs.parser.langs(content)
-            .fail(function(err) {
-                throw that.normError(err, {
-                    name: err.name || 'Langs Parse Error',
-                    fileName: that.langsFile
-                });
-            });
-        });
-    })
-    .then(function(langs) {
-        that.langs = langs;
-    });
-};
-
-// Parse summary to extract list of chapters
-Book.prototype.parseSummary = function() {
-    var that = this;
-
-    var filename = that.config.getStructure('summary', true);
-    that.log.debug.ln('start parsing summary:', filename);
-
-    return that.findFile(filename)
-    .then(function(summary) {
-        if (!summary) throw 'No SUMMARY file';
-
-        // Remove the summary from the list of files to parse
-        that.summaryFile = summary.path;
-        that._defaultsStructure(that.summaryFile);
-        that.files = _.without(that.files, that.summaryFile);
-
-        that.log.debug.ln('summary located at', that.summaryFile);
-        return that.template.renderFile(that.summaryFile)
-        .then(function(content) {
-            return summary.parser.summary(content, {
-                entryPoint: that.readmeFile,
-                entryPointTitle: that.i18n('SUMMARY_INTRODUCTION'),
-                files: that.files
-            })
-            .fail(function(err) {
-                throw that.normError(err, {
-                    name: err.name || 'Summary Parse Error',
-                    fileName: that.summaryFile
-                });
-            });
-        });
-    })
-    .then(function(summary) {
-        that.summary = summary;
-        that.navigation = parseNavigation(that.summary, that.files);
-    });
-};
-
-// Parse glossary to extract terms
-Book.prototype.parseGlossary = function() {
-    var that = this;
-
-    var filename = that.config.getStructure('glossary', true);
-    that.log.debug.ln('start parsing glossary: ', filename);
-
-    return that.findFile(filename)
-    .then(function(glossary) {
-        if (!glossary) return [];
-
-        // Remove the glossary from the list of files to parse
-        that.glossaryFile = glossary.path;
-        that._defaultsStructure(that.glossaryFile);
-        that.files = _.without(that.files, that.glossaryFile);
-
-        that.log.debug.ln('glossary located at', that.glossaryFile);
-        return that.template.renderFile(that.glossaryFile)
-        .then(function(content) {
-            return glossary.parser.glossary(content)
-            .fail(function(err) {
-                throw that.normError(err, {
-                    name: err.name || 'Glossary Parse Error',
-                    fileName: that.glossaryFile
-                });
-            });
-        });
-    })
-    .then(function(glossary) {
-        that.glossary = glossary;
-    });
-};
-
-// Parse a page
-Book.prototype.parsePage = function(filename, options) {
-    var that = this, page = {};
-    options = _.defaults(options || {}, {
-        // Transform svg images
-        convertImages: false,
-
-        // Interpolate before templating
-        interpolateTemplate: _.identity,
-
-        // Interpolate after templating
-        interpolateContent: _.identity
-    });
-
-    var interpolate = function(fn) {
-        return Q(fn(page))
-        .then(function(_page) {
-            page = _page || page;
-        });
-    };
-
-    that.log.debug.ln('start parsing file', filename);
-
-    var extension = path.extname(filename);
-    var filetype = parsers.get(extension);
-
-    if (!filetype) return Q.reject(new Error('Can\'t parse file: '+filename));
-
-    // Type of parser used
-    page.type = filetype.name;
-
-    // Path relative to book
-    page.path = filename;
-
-    // Path absolute in the system
-    page.rawPath = path.resolve(that.root, filename);
-
-    // Progress in the book
-    page.progress = parseProgress(that.navigation, filename);
-
-    that.log.debug.ln('render template', filename);
-
-    // Read file content
-    return that.readFile(page.path)
-    .then(function(content) {
-        page.content = content;
-
-        return interpolate(options.interpolateTemplate);
-    })
-
-    // Prepare page markup
-    .then(function() {
-        return filetype.page.prepare(page.content)
-        .then(function(content) {
-            page.content = content;
-        });
-    })
-
-    // Generate template
-    .then(function() {
-        return that.template.renderPage(page);
-    })
-
-    // Prepare and Parse markup
-    .then(function(content) {
-        page.content = content;
-
-        that.log.debug.ln('use file parser', filetype.name, 'for', filename);
-        return filetype.page(page.content);
-    })
-
-    // Post process sections
-    .then(function(_page) {
-        return _.reduce(_page.sections, function(prev, section) {
-            return prev.then(function(_sections) {
-                return that.template.postProcess(section.content || '')
-                .then(function(content) {
-                    section.content = content;
-                    return _sections.concat([section]);
-                });
-            });
-        }, Q([]));
-    })
-
-    // Prepare html
-    .then(function(_sections) {
-        return pageUtil.normalize(_sections, {
-            book: that,
-            convertImages: options.convertImages,
-            input: filename,
-            navigation: that.navigation,
-            base: path.dirname(filename) || './',
-            output: path.dirname(filename) || './',
-            glossary: that.glossary
-        });
-    })
-
-    // Interpolate output
-    .then(function(_sections) {
-        page.sections = _sections;
-        return interpolate(options.interpolateContent);
-    })
-
-    .then(function() {
-        return page;
-    });
-};
-
-// Find file that can be parsed with a specific filename
-Book.prototype.findFile = function(filename) {
-    var that = this;
-
-    var ext = path.extname(filename);
-    var basename = path.basename(filename, ext);
-
-    // Ordered list of extensions to test
-    var exts = parsers.extensions;
-    if (ext) exts = _.uniq([ext].concat(exts));
-
-    return _.reduce(exts, function(prev, ext) {
-        return prev.then(function(output) {
-            // Stop if already find a parser
-            if (output) return output;
-
-            var filepath = basename+ext;
-
-            return fs.findFile(that.root, filepath)
-            .then(function(realFilepath) {
-                if (!realFilepath) return null;
-
-                return {
-                    parser: parsers.get(ext),
-                    path: realFilepath
-                };
-            });
-        });
-    }, Q(null));
-};
-
-// Format a string using a specific markup language
-Book.prototype.formatString = function(extension, content) {
-    return Q()
-    .then(function() {
-        var filetype = parsers.get(extension);
-        if (!filetype) throw new Error('Filetype doesn\'t exist: '+filetype);
-
-        return filetype.page(content);
-    })
-
-    // Merge sections
-    .then(function(page) {
-        return _.reduce(page.sections, function(content, section) {
-            return content + section.content;
-        }, '');
-    });
-};
-
-// Check if a file exists in the book
-Book.prototype.fileExists = function(filename) {
-    return fs.exists(
-        this.resolve(filename)
-    );
-};
-
-// Check if a file path is inside the book
-Book.prototype.fileIsInBook = function(filename) {
-    return pathUtil.isInRoot(this.root, filename);
-};
-
-// Read a file
-Book.prototype.readFile = function(filename) {
-    return fs.readFile(
-        this.resolve(filename),
-        { encoding: 'utf8' }
-    );
-};
-
-// Return stat for a file
-Book.prototype.statFile = function(filename) {
-    return fs.stat(this.resolve(filename));
-};
-
-// List all files in the book
-Book.prototype.listAllFiles = function() {
-    var that = this;
-
-    return fs.list(this.root, {
-        ignoreFiles: ['.ignore', '.gitignore', '.bookignore'],
-        ignoreRules: [
-            // Skip Git stuff
-            '.git/',
-            '.gitignore',
-
-            // Skip OS X meta data
-            '.DS_Store',
-
-            // Skip stuff installed by plugins
-            'node_modules',
-
-            // Skip book outputs
-            '_book',
-            '*.pdf',
-            '*.epub',
-            '*.mobi',
-
-            // Skip config files
-            '.ignore',
-            '.bookignore',
-            'book.json',
-        ]
-    })
-    .then(function(_files) {
-        that.files = _files;
-    });
-};
-
-// Return true if the book is a multilingual book
-Book.prototype.isMultilingual = function() {
-    return this.books.length > 0;
-};
-
-// Return root of the parent
-Book.prototype.parentRoot = function() {
-    if (this.parent) return this.parent.parentRoot();
-    return this.root;
-};
-
-// Return true if it's a sub-book
-Book.prototype.isSubBook = function() {
-    return !!this.parent;
-};
-
-// Test if the file is the entry point
-Book.prototype.isEntryPoint = function(fp) {
-    return fp == this.readmeFile;
-};
-
-// Alias to book.config.get
-Book.prototype.getConfig = function(key, def) {
-    return this.config.get(key, def);
-};
-
-// Resolve a path in the book source
-// Enforce that the output path in the root folder
-Book.prototype.resolve = function() {
-    return pathUtil.resolveInRoot.apply(null, [this.root].concat(_.toArray(arguments)));
-};
-
-// Convert an abslute path into a relative path to this
-Book.prototype.relative = function(p) {
-    return path.relative(this.root, p);
-};
-
-// Normalize a path to .html and convert README -> index
-Book.prototype.contentPath = function(link) {
-    if (
-        path.basename(link, path.extname(link)) == 'README' ||
-        link == this.readmeFile
-    ) {
-        link = path.join(path.dirname(link), 'index'+path.extname(link));
-    }
-
-    link = links.changeExtension(link, '.html');
-    return link;
-};
-
-// Normalize a link to .html and convert README -> index
-Book.prototype.contentLink = function(link) {
-    return links.normalize(this.contentPath(link));
-};
-
-// Default structure paths to an extension
-Book.prototype._defaultsStructure = function(filename) {
-    var that = this;
-    var extension = path.extname(filename);
-
-    that.readmeFile = that.readmeFile || that.config.getStructure('readme')+extension;
-    that.summaryFile = that.summaryFile || that.config.getStructure('summary')+extension;
-    that.glossaryFile = that.glossaryFile || that.config.getStructure('glossary')+extension;
-    that.langsFile = that.langsFile || that.config.getStructure('langs')+extension;
-};
-
-// Change output path
-Book.prototype.setOutput = function(p) {
-    var that = this;
-    this.options.output = path.resolve(p);
-
-    _.each(this.books, function(book) {
-        book.setOutput(path.join(that.options.output, book.options.language));
-    });
-};
-
-// Translate a strign according to the book language
-Book.prototype.i18n = function() {
-    var args = Array.prototype.slice.call(arguments);
-    return i18n.__.apply({}, [this.config.normalizeLanguage()].concat(args));
-};
-
-// Normalize error
-Book.prototype.normError = function(err, opts, defs) {
-    if (_.isString(err)) err = new Error(err);
-
-    // Extend err
-    _.extend(err, opts || {});
-    _.defaults(err, defs || {});
-
-    err.lineNumber = err.lineNumber || err.lineno;
-    err.columnNumber = err.columnNumber || err.colno;
-
-    err.toString = function() {
-        var attributes = [];
-
-        if (this.fileName) attributes.push('In file \''+this.fileName+'\'');
-        if (this.lineNumber) attributes.push('Line '+this.lineNumber);
-        if (this.columnNumber) attributes.push('Column '+this.columnNumber);
-        return (this.name || 'Error')+': '+this.message+((attributes.length > 0)? ' ('+attributes.join(', ')+')' : '');
-    };
-
-    return err;
-};
-
-// Call a hook in plugins
-Book.prototype.callHook = function(name, data) {
-    return this.plugins.hook(name, data);
-};
-
-module.exports= Book;

lib/config_default.js

@@ -1,109 +0,0 @@
-var path = require('path');
-
-module.exports = {
-    // Options that can't be extend
-    'configFile': 'book',
-    'generator': 'website',
-    'extension': null,
-
-    // Book metadats (somes are extracted from the README by default)
-    'title': null,
-    'description': null,
-    'isbn': null,
-    'language': 'en',
-    'direction': null,
-    'author': null,
-
-    // version of gitbook to use
-    'gitbook': '*',
-
-    // Structure
-    'structure': {
-        'langs': 'LANGS.md',
-        'readme': 'README.md',
-        'glossary': 'GLOSSARY.md',
-        'summary': 'SUMMARY.md'
-    },
-
-    // CSS Styles
-    'styles': {
-        'website': 'styles/website.css',
-        'print': 'styles/print.css',
-        'ebook': 'styles/ebook.css',
-        'pdf': 'styles/pdf.css',
-        'mobi': 'styles/mobi.css',
-        'epub': 'styles/epub.css'
-    },
-
-    // Plugins list, can contain '-name' for removing default plugins
-    'plugins': [],
-
-    // Global configuration for plugins
-    'pluginsConfig': {},
-
-    // Variables for templating
-    'variables': {},
-
-    // Set another theme with your own layout
-    // It's recommended to use plugins or add more options for default theme, though
-    // See https://github.com/GitbookIO/gitbook/issues/209
-    'theme': path.resolve(__dirname, '../theme'),
-
-    // Links in template (null: default, false: remove, string: new value)
-    'links': {
-        // Custom links at top of sidebar
-        'sidebar': {
-            // 'Custom link name': 'https://customlink.com'
-        },
-
-        // Sharing links
-        'sharing': {
-            'google': null,
-            'facebook': null,
-            'twitter': null,
-            'weibo': null,
-            'all': null
-        }
-    },
-
-
-    // Options for PDF generation
-    'pdf': {
-        // Add toc at the end of the file
-        'toc': true,
-
-        // Add page numbers to the bottom of every page
-        'pageNumbers': false,
-
-        // Font for the file content
-        'fontSize': 12,
-        'fontFamily': 'Arial',
-
-        // Paper size for the pdf
-        // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
-        'paperSize': 'a4',
-
-        // How to mark detected chapters.
-        // Choices are “pagebreak”, “rule”, 'both' or “none”.
-        'chapterMark' : 'pagebreak',
-
-        // An XPath expression. Page breaks are inserted before the specified elements.
-        // To disable use the expression: '/'
-        'pageBreaksBefore': '/',
-
-        // Margin (in pts)
-        // Note: 72 pts equals 1 inch
-        'margin': {
-            'right': 62,
-            'left': 62,
-            'top': 56,
-            'bottom': 56
-        },
-
-        // Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        'headerTemplate': null,
-
-        // Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        'footerTemplate': null
-    }
-};

lib/configuration.js

@@ -1,210 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var path = require('path');
-var semver = require('semver');
-
-var pkg = require('../package.json');
-var i18n = require('./utils/i18n');
-var version = require('./version');
-
-var DEFAULT_CONFIG = require('./config_default');
-
-// Default plugins added to each books
-var DEFAULT_PLUGINS = ['highlight', 'search', 'sharing', 'fontsettings'];
-
-// Check if a plugin is a default plugin
-// Plugin should be in the list
-// And version from book.json specified for this plugin should be satisfied
-function isDefaultPlugin(name, version) {
-    if (!_.contains(DEFAULT_PLUGINS, name)) return false;
-
-    try {
-        var pluginPkg = require('gitbook-plugin-'+name+'/package.json');
-        return semver.satisfies(pluginPkg.version, version || '*');
-    } catch(e) {
-        return false;
-    }
-}
-
-// Normalize a list of plugins to use
-function normalizePluginsList(plugins, addDefaults) {
-    // Normalize list to an array
-    plugins = _.isString(plugins) ? plugins.split(',') : (plugins || []);
-
-    // Remove empty parts
-    plugins = _.compact(plugins);
-
-    // Divide as {name, version} to handle format like 'myplugin@1.0.0'
-    plugins = _.map(plugins, function(plugin) {
-        if (plugin.name) return plugin;
-
-        var parts = plugin.split('@');
-        var name = parts[0];
-        var version = parts[1];
-        return {
-            'name': name,
-            'version': version, // optional
-            'isDefault': isDefaultPlugin(name, version)
-        };
-    });
-
-    // List plugins to remove
-    var toremove = _.chain(plugins)
-    .filter(function(plugin) {
-        return plugin.name.length > 0 && plugin.name[0] == '-';
-    })
-    .map(function(plugin) {
-        return plugin.name.slice(1);
-    })
-    .value();
-
-    // Merge with defaults
-    if (addDefaults !== false) {
-        _.each(DEFAULT_PLUGINS, function(plugin) {
-            if (_.find(plugins, { name: plugin })) {
-                return;
-            }
-
-            plugins.push({
-                'name': plugin,
-                'isDefault': true
-            });
-        });
-    }
-
-    // Remove plugin that start with '-'
-    plugins = _.filter(plugins, function(plugin) {
-        return !_.contains(toremove, plugin.name) && !(plugin.name.length > 0 && plugin.name[0] == '-');
-    });
-
-    // Remove duplicates
-    plugins = _.uniq(plugins, 'name');
-
-    return plugins;
-}
-
-var Configuration = function(book, options) {
-    this.book = book;
-    this.replace(options);
-};
-
-// Read and parse the configuration
-Configuration.prototype.load = function() {
-    var that = this;
-
-    return Q()
-    .then(function() {
-        var configPath, _config;
-
-        try {
-            configPath = require.resolve(
-                that.book.resolve(that.options.configFile)
-            );
-
-            // Invalidate node.js cache for livreloading
-            delete require.cache[configPath];
-
-            _config = require(configPath);
-            that.options = _.merge(
-                that.options,
-                _.omit(_config, 'configFile', 'defaultsPlugins', 'generator', 'extension')
-            );
-        }
-        catch(err) {
-            if (err instanceof SyntaxError) return Q.reject(err);
-            return Q();
-        }
-    })
-    .then(function() {
-        if (!that.book.isSubBook()) {
-            if (!version.satisfies(that.options.gitbook)) {
-                throw new Error('GitBook version doesn\'t satisfy version required by the book: '+that.options.gitbook);
-            }
-            if (that.options.gitbook != '*' && !semver.satisfies(semver.inc(pkg.version, 'patch'), that.options.gitbook)) {
-                that.book.log.warn.ln('gitbook version specified in your book.json might be too strict for future patches, \''+(_.first(pkg.version.split('.'))+'.x.x')+'\' is more adequate');
-            }
-        }
-
-        that.options.output = path.resolve(that.options.output || that.book.resolve('_book'));
-        that.options.plugins = normalizePluginsList(that.options.plugins);
-        that.options.defaultsPlugins = normalizePluginsList(that.options.defaultsPlugins || '', false);
-        that.options.plugins = _.union(that.options.plugins, that.options.defaultsPlugins);
-        that.options.plugins = _.uniq(that.options.plugins, 'name');
-
-        // Default value for text direction (from language)
-        if (!that.options.direction) {
-            var lang = i18n.getCatalog(that.options.language);
-            if (lang) that.options.direction = lang.direction;
-        }
-
-        that.options.gitbook = pkg.version;
-    });
-};
-
-// Extend the configuration
-Configuration.prototype.extend = function(options) {
-    _.extend(this.options, options);
-};
-
-// Replace the whole configuration
-Configuration.prototype.replace = function(options) {
-    var that = this;
-
-    this.options = _.cloneDeep(DEFAULT_CONFIG);
-    this.options = _.merge(this.options, options || {});
-
-    // options.input == book.root
-    Object.defineProperty(this.options, 'input', {
-        get: function () {
-            return that.book.root;
-        }
-    });
-
-    // options.originalInput == book.parent.root
-    Object.defineProperty(this.options, 'originalInput', {
-        get: function () {
-            return that.book.parent? that.book.parent.root : undefined;
-        }
-    });
-
-    // options.originalOutput == book.parent.options.output
-    Object.defineProperty(this.options, 'originalOutput', {
-        get: function () {
-            return that.book.parent? that.book.parent.options.output : undefined;
-        }
-    });
-};
-
-// Dump configuration as json object
-Configuration.prototype.dump = function() {
-    return _.cloneDeep(this.options);
-};
-
-// Get structure file
-Configuration.prototype.getStructure = function(name, dontStripExt) {
-    var filename = this.options.structure[name];
-    if (dontStripExt) return filename;
-
-    filename = filename.split('.').slice(0, -1).join('.');
-    return filename;
-};
-
-// Return normalized language
-Configuration.prototype.normalizeLanguage = function() {
-    return i18n.normalizeLanguage(this.options.language);
-};
-
-// Return a configuration
-Configuration.prototype.get = function(key, def) {
-    return _.get(this.options, key, def);
-};
-
-// Update a configuration
-Configuration.prototype.set = function(key, value) {
-    return _.set(this.options, key, value);
-};
-
-// Default configuration
-Configuration.DEFAULT = DEFAULT_CONFIG;
-
-module.exports= Configuration;

lib/conrefs_loader.js

@@ -1,73 +0,0 @@
-var _ = require('lodash');
-var path = require('path');
-var nunjucks = require('nunjucks');
-
-var git = require('./utils/git');
-var fs = require('./utils/fs');
-var pathUtil = require('./utils/path');
-
-// The loader should handle relative and git url
-var BookLoader = nunjucks.Loader.extend({
-    async: true,
-
-    init: function(book, opts) {
-        this.opts = _.defaults(opts || {}, {
-            interpolate: _.identity
-        });
-        this.book = book;
-    },
-
-    getSource: function(fileurl, callback) {
-        var that = this;
-
-        git.resolveFile(fileurl)
-        .then(function(filepath) {
-            // Is local file
-            if (!filepath) filepath = path.resolve(fileurl);
-            else that.book.log.debug.ln('resolve from git', fileurl, 'to', filepath);
-
-            //  Read file from absolute path
-            return fs.readFile(filepath)
-            .then(function(source) {
-                return that.opts.interpolate(filepath, source.toString());
-            })
-            .then(function(source) {
-                return {
-                    src: source,
-                    path: filepath,
-
-                    // We disable cache sincde content is modified (shortcuts, ...)
-                    noCache: true
-                };
-            });
-        })
-        .nodeify(callback);
-    },
-
-    resolve: function(from, to) {
-        // If origin is in the book, we enforce result file to be in the book
-        if (this.book.fileIsInBook(from)) {
-            return this.book.resolve(
-                this.book.relative(path.dirname(from)),
-                to
-            );
-        }
-
-        // If origin is in a git repository, we resolve file in the git repository
-        var gitRoot = git.resolveRoot(from);
-        if (gitRoot) {
-            return pathUtil.resolveInRoot(gitRoot, to);
-        }
-
-        // If origin is not in the book (include from a git content ref)
-        return path.resolve(path.dirname(from), to);
-    },
-
-    // Handle all files as relative, so that nunjucks pass responsability to 'resolve'
-    // Only git urls are considered as absolute
-    isRelative: function(filename) {
-        return !git.checkUrl(filename);
-    }
-});
-
-module.exports = BookLoader;

lib/generator.js

@@ -1,76 +0,0 @@
-var _ = require('lodash');
-var path = require('path');
-var Q = require('q');
-var fs = require('./utils/fs');
-
-var BaseGenerator = function(book) {
-    this.book = book;
-
-    Object.defineProperty(this, 'options', {
-        get: function () {
-            return this.book.options;
-        }
-    });
-
-    _.bindAll(this);
-};
-
-BaseGenerator.prototype.callHook = function(name, data) {
-    return this.book.callHook(name, data);
-};
-
-// Prepare the genertor
-BaseGenerator.prototype.prepare = function() {
-    var that = this;
-
-    return that.callHook('init');
-};
-
-// Write a parsed file to the output
-BaseGenerator.prototype.convertFile = function(input) {
-    return Q.reject(new Error('Could not convert '+input));
-};
-
-// Copy file to the output (non parsable)
-BaseGenerator.prototype.transferFile = function(input) {
-    return fs.copy(
-        this.book.resolve(input),
-        path.join(this.options.output, input)
-    );
-};
-
-// Copy a folder to the output
-BaseGenerator.prototype.transferFolder = function(input) {
-    return fs.mkdirp(
-        path.join(this.book.options.output, input)
-    );
-};
-
-// Copy the cover picture
-BaseGenerator.prototype.copyCover = function() {
-    var that = this;
-
-    return Q.all([
-        fs.copy(that.book.resolve('cover.jpg'), path.join(that.options.output, 'cover.jpg')),
-        fs.copy(that.book.resolve('cover_small.jpg'), path.join(that.options.output, 'cover_small.jpg'))
-    ])
-    .fail(function() {
-        // If orignaly from multi-lang, try copy from parent
-        if (!that.book.isSubBook()) return;
-
-        return Q.all([
-            fs.copy(path.join(that.book.parentRoot(), 'cover.jpg'), path.join(that.options.output, 'cover.jpg')),
-            fs.copy(path.join(that.book.parentRoot(), 'cover_small.jpg'), path.join(that.options.output, 'cover_small.jpg'))
-        ]);
-    })
-    .fail(function() {
-        return Q();
-    });
-};
-
-// At teh end of the generation
-BaseGenerator.prototype.finish = function() {
-    return Q.reject(new Error('Could not finish generation'));
-};
-
-module.exports = BaseGenerator;

lib/generators/ebook.js

@@ -1,172 +0,0 @@
-var util = require('util');
-var path = require('path');
-var Q = require('q');
-var _ = require('lodash');
-var juice = require('juice');
-var exec = require('child_process').exec;
-
-var fs = require('../utils/fs');
-var stringUtils = require('../utils/string');
-var BaseGenerator = require('./website');
-
-var Generator = function(book, format) {
-    BaseGenerator.apply(this, arguments);
-
-    // eBook format
-    this.ebookFormat = format;
-
-    // Resources namespace
-    this.namespace = 'ebook';
-
-    // Styles to use
-    this.styles = _.compact(['print', 'ebook', this.ebookFormat]);
-
-    // Convert images (svg -> png)
-    this.convertImages = true;
-};
-util.inherits(Generator, BaseGenerator);
-
-Generator.prototype.prepareTemplates = function() {
-    this.templates.page = this.book.plugins.template('ebook:page') || path.resolve(this.options.theme, 'templates/ebook/page.html');
-    this.templates.summary = this.book.plugins.template('ebook:summary') || path.resolve(this.options.theme, 'templates/ebook/summary.html');
-    this.templates.glossary = this.book.plugins.template('ebook:glossary') || path.resolve(this.options.theme, 'templates/ebook/glossary.html');
-
-    return Q();
-};
-
-// Generate table of contents
-Generator.prototype.writeSummary = function() {
-    var that = this;
-
-    that.book.log.info.ln('write SUMMARY.html');
-    return this._writeTemplate(this.templates.summary, {}, path.join(this.options.output, 'SUMMARY.html'));
-};
-
-// Return template for footer/header with inlined css
-Generator.prototype.getPDFTemplate = function(id) {
-    var tpl = this.options.pdf[id+'Template'];
-    var defaultTpl = path.resolve(this.options.theme, 'templates/ebook/'+id+'.html');
-    var defaultCSS = path.resolve(this.options.theme, 'assets/ebook/pdf.css');
-
-    // Default template from theme
-    if (!tpl && fs.existsSync(defaultTpl)) {
-        tpl = fs.readFileSync(defaultTpl, { encoding: 'utf-8' });
-    }
-
-    // Inline CSS using juice
-    var stylesheets = [];
-
-    // From theme
-    if (fs.existsSync(defaultCSS)) {
-        stylesheets.push(fs.readFileSync(defaultCSS, { encoding: 'utf-8' }));
-    }
-
-    // Custom PDF style
-    if (this.styles.pdf) {
-        stylesheets.push(fs.readFileSync(this.book.resolve(this.styles.pdf), { encoding: 'utf-8' }));
-    }
-
-    tpl = juice(tpl, {
-        extraCss: stylesheets.join('\n\n')
-    });
-
-    return tpl;
-};
-
-Generator.prototype.finish = function() {
-    var that = this;
-
-    return Q()
-    .then(this.copyAssets)
-    .then(this.copyCover)
-    .then(this.writeGlossary)
-    .then(this.writeSummary)
-    .then(function() {
-        if (!that.ebookFormat) return Q();
-
-        if (!that.options.cover && fs.existsSync(path.join(that.options.output, 'cover.jpg'))) {
-            that.options.cover = path.join(that.options.output, 'cover.jpg');
-        }
-
-        var d = Q.defer();
-
-        var _options = {
-            '--cover': that.options.cover,
-            '--title': that.options.title,
-            '--comments': that.options.description,
-            '--isbn': that.options.isbn,
-            '--authors': that.options.author,
-            '--language': that.options.language,
-            '--book-producer': 'GitBook',
-            '--publisher': 'GitBook',
-            '--chapter': 'descendant-or-self::*[contains(concat(\' \', normalize-space(@class), \' \'), \' book-chapter \')]',
-            '--level1-toc': 'descendant-or-self::*[contains(concat(\' \', normalize-space(@class), \' \'), \' book-chapter-1 \')]',
-            '--level2-toc': 'descendant-or-self::*[contains(concat(\' \', normalize-space(@class), \' \'), \' book-chapter-2 \')]',
-            '--level3-toc': 'descendant-or-self::*[contains(concat(\' \', normalize-space(@class), \' \'), \' book-chapter-3 \')]',
-            '--no-chapters-in-toc': true,
-            '--max-levels': '1',
-            '--breadth-first': true
-        };
-
-        if (that.ebookFormat == 'pdf') {
-            var pdfOptions = that.options.pdf;
-
-            _.extend(_options, {
-                '--chapter-mark': String(pdfOptions.chapterMark),
-                '--page-breaks-before': String(pdfOptions.pageBreaksBefore),
-                '--margin-left': String(pdfOptions.margin.left),
-                '--margin-right': String(pdfOptions.margin.right),
-                '--margin-top': String(pdfOptions.margin.top),
-                '--margin-bottom': String(pdfOptions.margin.bottom),
-                '--pdf-default-font-size': String(pdfOptions.fontSize),
-                '--pdf-mono-font-size': String(pdfOptions.fontSize),
-                '--paper-size': String(pdfOptions.paperSize),
-                '--pdf-page-numbers': Boolean(pdfOptions.pageNumbers),
-                '--pdf-header-template': that.getPDFTemplate('header'),
-                '--pdf-footer-template': that.getPDFTemplate('footer'),
-                '--pdf-sans-family': String(pdfOptions.fontFamily)
-            });
-        } else if (that.ebookFormat == 'epub') {
-            _.extend(_options, {
-                '--dont-split-on-page-breaks': true
-            });
-        }
-
-        var command = [
-            'ebook-convert',
-            path.join(that.options.output, 'SUMMARY.html'),
-            path.join(that.options.output, 'index.'+that.ebookFormat),
-            stringUtils.optionsToShellArgs(_options)
-        ].join(' ');
-
-        that.book.log.info('start conversion to', that.ebookFormat, '....');
-
-        var child = exec(command, function (error, stdout) {
-            if (error) {
-                that.book.log.info.fail();
-
-                if (error.code == 127) {
-                    error.message = 'Need to install ebook-convert from Calibre';
-                } else {
-                    error.message = error.message + ' '+stdout;
-                }
-                return d.reject(error);
-            }
-
-            that.book.log.info.ok();
-            d.resolve();
-        });
-
-        child.stdout.on('data', function (data) {
-            that.book.log.debug(data);
-        });
-
-        child.stderr.on('data', function (data) {
-            that.book.log.debug(data);
-        });
-
-        return d.promise;
-    });
-};
-
-module.exports = Generator;

lib/generators/index.js

@@ -1,11 +0,0 @@
-var _ = require("lodash");
-var EbookGenerator = require("./ebook");
-
-module.exports = {
-    json: require("./json"),
-    website: require("./website"),
-    ebook: EbookGenerator,
-    pdf: _.partialRight(EbookGenerator, "pdf"),
-    mobi: _.partialRight(EbookGenerator, "mobi"),
-    epub: _.partialRight(EbookGenerator, "epub")
-};

lib/generators/json.js

@@ -1,76 +0,0 @@
-var util = require('util');
-var path = require('path');
-var Q = require('q');
-var _ = require('lodash');
-
-var fs = require('../utils/fs');
-var BaseGenerator = require('../generator');
-var links = require('../utils/links');
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-};
-util.inherits(Generator, BaseGenerator);
-
-// Ignore some methods
-Generator.prototype.transferFile = function() { };
-
-// Convert an input file
-Generator.prototype.convertFile = function(input) {
-    var that = this;
-
-    return that.book.parsePage(input)
-    .then(function(page) {
-        var json = {
-            progress: page.progress,
-            sections: page.sections
-        };
-
-        var output = links.changeExtension(page.path, '.json');
-        output = path.join(that.options.output, output);
-
-        return fs.writeFile(
-            output,
-            JSON.stringify(json, null, 4)
-        );
-    });
-};
-
-// Finish generation
-Generator.prototype.finish = function() {
-    return this.writeReadme();
-};
-
-// Write README.json
-Generator.prototype.writeReadme = function() {
-    var that = this;
-    var mainLang, langs, readme;
-
-    return Q()
-    .then(function() {
-        langs = that.book.langs;
-        mainLang = langs.length > 0? _.first(langs).lang : null;
-
-        readme = links.changeExtension(that.book.readmeFile, '.json');
-
-        // Read readme from main language
-        return fs.readFile(
-            mainLang? path.join(that.options.output, mainLang, readme) : path.join(that.options.output, readme)
-        );
-    })
-    .then(function(content) {
-        // Extend it with infos about the languages
-        var json = JSON.parse(content);
-        _.extend(json, {
-            langs: langs
-        });
-
-        // Write it as README.json
-        return fs.writeFile(
-            path.join(that.options.output, 'README.json'),
-            JSON.stringify(json, null, 4)
-        );
-    });
-};
-
-module.exports = Generator;

lib/generators/website.js

@@ -1,263 +0,0 @@
-var util = require('util');
-var path = require('path');
-var Q = require('q');
-var _ = require('lodash');
-
-var nunjucks = require('nunjucks');
-var AutoEscapeExtension = require('nunjucks-autoescape')(nunjucks);
-var FilterExtension = require('nunjucks-filter')(nunjucks);
-
-var fs = require('../utils/fs');
-var BaseGenerator = require('../generator');
-var links = require('../utils/links');
-var i18n = require('../utils/i18n');
-
-var pkg = require('../../package.json');
-
-var Generator = function() {
-    BaseGenerator.apply(this, arguments);
-
-    // Revision
-    this.revision = new Date();
-
-    // Resources namespace
-    this.namespace = 'website';
-
-    // Style to integrates in the output
-    this.styles = ['website'];
-
-    // Convert images (svg -> png)
-    this.convertImages = false;
-
-    // Templates
-    this.templates = {};
-};
-util.inherits(Generator, BaseGenerator);
-
-// Prepare the genertor
-Generator.prototype.prepare = function() {
-    return BaseGenerator.prototype.prepare.apply(this)
-    .then(this.prepareStyles)
-    .then(this.prepareTemplates)
-    .then(this.prepareTemplateEngine);
-};
-
-// Prepare all styles
-Generator.prototype.prepareStyles = function() {
-    var that = this;
-
-    this.styles = _.chain(this.styles)
-        .map(function(style) {
-            var stylePath = that.options.styles[style];
-            if (stylePath && fs.existsSync(that.book.resolve(stylePath))) {
-                return [style, stylePath];
-            }
-            return null;
-        })
-        .compact()
-        .object()
-        .value();
-
-    return Q();
-};
-
-// Prepare templates
-Generator.prototype.prepareTemplates = function() {
-    this.templates.page = this.book.plugins.template('site:page') || path.resolve(this.options.theme, 'templates/website/page.html');
-    this.templates.langs = this.book.plugins.template('site:langs') || path.resolve(this.options.theme, 'templates/website/langs.html');
-    this.templates.glossary = this.book.plugins.template('site:glossary') || path.resolve(this.options.theme, 'templates/website/glossary.html');
-
-    return Q();
-};
-
-// Prepare template engine
-Generator.prototype.prepareTemplateEngine = function() {
-    var that = this;
-
-    return Q()
-    .then(function() {
-        var language = that.book.config.normalizeLanguage();
-
-        if (!i18n.hasLocale(language)) {
-            that.book.log.warn.ln('Language "'+language+'" is not available as a layout locales (en, '+i18n.getLocales().join(', ')+')');
-        }
-
-        var folders = _.chain(that.templates)
-            .values()
-            .map(path.dirname)
-            .uniq()
-            .value();
-
-        that.env = new nunjucks.Environment(
-            new nunjucks.FileSystemLoader(folders),
-            {
-                autoescape: true
-            }
-        );
-
-        // Add filter
-        that.env.addFilter('contentLink', that.book.contentLink.bind(that.book));
-        that.env.addFilter('lvl', function(lvl) {
-            return lvl.split('.').length;
-        });
-
-        // Add extension
-        that.env.addExtension('AutoEscapeExtension', new AutoEscapeExtension(that.env));
-        that.env.addExtension('FilterExtension', new FilterExtension(that.env));
-    });
-};
-
-// Finis generation
-Generator.prototype.finish = function() {
-    return this.copyAssets()
-    .then(this.copyCover)
-    .then(this.writeGlossary)
-    .then(this.writeLangsIndex);
-};
-
-// Convert an input file
-Generator.prototype.convertFile = function(input) {
-    var that = this;
-
-    return that.book.parsePage(input, {
-        convertImages: that.convertImages,
-        interpolateTemplate: function(page) {
-            return that.callHook('page:before', page);
-        },
-        interpolateContent: function(page) {
-            return that.callHook('page', page);
-        }
-    })
-    .then(function(page) {
-        var relativeOutput = that.book.contentPath(page.path);
-        var output = path.join(that.options.output, relativeOutput);
-
-        var basePath = path.relative(path.dirname(output), that.options.output) || '.';
-        if (process.platform === 'win32') basePath = basePath.replace(/\\/g, '/');
-
-        that.book.log.debug.ln('write parsed file', page.path, 'to', relativeOutput);
-
-        return that._writeTemplate(that.templates.page, {
-            progress: page.progress,
-
-            _input: page.path,
-            content: page.sections,
-
-            basePath: basePath,
-            staticBase: links.join(basePath, 'gitbook')
-        }, output);
-    });
-};
-
-// Write the index for langs
-Generator.prototype.writeLangsIndex = function() {
-    if (!this.book.langs.length) return Q();
-
-    return this._writeTemplate(this.templates.langs, {
-        langs: this.book.langs
-    }, path.join(this.options.output, 'index.html'));
-};
-
-// Write glossary
-Generator.prototype.writeGlossary = function() {
-    // No glossary
-    if (this.book.glossary.length === 0) return Q();
-
-    return this._writeTemplate(this.templates.glossary, {}, path.join(this.options.output, 'GLOSSARY.html'));
-};
-
-// Convert a page into a normalized data set
-Generator.prototype.normalizePage  = function(page) {
-    var that = this;
-
-    var _callHook = function(name) {
-        return that.callHook(name, page)
-        .then(function(_page) {
-            page = _page;
-            return page;
-        });
-    };
-
-    return Q()
-    .then(function() {
-        return _callHook('page');
-    })
-    .then(function() {
-        return page;
-    });
-};
-
-// Generate a template
-Generator.prototype._writeTemplate = function(tpl, options, output, interpolate) {
-    var that = this;
-
-    interpolate = interpolate || _.identity;
-    return Q()
-    .then(function() {
-        return that.env.render(
-            tpl,
-            _.extend({
-                gitbook: {
-                    version: pkg.version
-                },
-
-                styles: that.styles,
-
-                revision: that.revision,
-
-                title: that.options.title,
-                description: that.options.description,
-                language: that.book.config.normalizeLanguage(),
-                innerlanguage: that.book.isSubBook()? that.book.config.get('language') : null,
-
-                glossary: that.book.glossary,
-
-                summary: that.book.summary,
-                allNavigation: that.book.navigation,
-
-                plugins: {
-                    resources: that.book.plugins.resources(that.namespace)
-                },
-                pluginsConfig: JSON.stringify(that.options.pluginsConfig),
-                htmlSnippet: _.partial(_.partialRight(that.book.plugins.html, that, options), that.namespace),
-
-                options: that.options,
-
-                basePath: '.',
-                staticBase: path.join('.', 'gitbook'),
-
-                '__': that.book.i18n.bind(that.book)
-            }, options)
-        );
-    })
-    .then(interpolate)
-    .then(function(html) {
-        return fs.writeFile(
-            output,
-            html
-        );
-    });
-};
-
-// Copy assets
-Generator.prototype.copyAssets = function() {
-    var that = this;
-
-    // Copy gitbook assets
-    return fs.copy(
-        path.join(that.options.theme, 'assets/'+this.namespace),
-        path.join(that.options.output, 'gitbook')
-    )
-
-    // Copy plugins assets
-    .then(function() {
-        return Q.all(
-            _.map(that.book.plugins.list, function(plugin) {
-                var pluginAssets = path.join(that.options.output, 'gitbook/plugins/', plugin.name);
-                return plugin.copyAssets(pluginAssets, that.namespace);
-            })
-        );
-    });
-};
-
-module.exports = Generator;

lib/index.js

@@ -1,215 +0,0 @@
-/* eslint no-console: 0 */
-
-var Q = require('q');
-var _ = require('lodash');
-var path = require('path');
-var tinylr = require('tiny-lr');
-var color = require('bash-color');
-
-var Book = require('./book');
-var initBook = require('./init');
-var Server = require('./utils/server');
-var stringUtils = require('./utils/string');
-var watch = require('./utils/watch');
-var logger = require('./utils/logger');
-
-var LOG_OPTION = {
-    name: 'log',
-    description: 'Minimum log level to display',
-    values: _.chain(logger.LEVELS).keys().map(stringUtils.toLowerCase).value(),
-    defaults: 'info'
-};
-
-var FORMAT_OPTION = {
-    name: 'format',
-    description: 'Format to build to',
-    values: ['website', 'json', 'ebook'],
-    defaults: 'website'
-};
-
-// Export init to gitbook library
-Book.init = initBook;
-
-module.exports = {
-    Book: Book,
-    LOG_LEVELS: logger.LEVELS,
-
-    commands: _.flatten([
-        {
-            name: 'build [book] [output]',
-            description: 'build a book',
-            options: [
-                FORMAT_OPTION,
-                LOG_OPTION
-            ],
-            exec: function(args, kwargs) {
-                var input = args[0] || process.cwd();
-                var output = args[1] || path.join(input, '_book');
-
-                var book = new Book(input, _.extend({}, {
-                    'config': {
-                        'output': output
-                    },
-                    'logLevel': kwargs.log
-                }));
-
-                return book.parse()
-                .then(function() {
-                    return book.generate(kwargs.format);
-                })
-                .then(function(){
-                    console.log('');
-                    console.log(color.green('Done, without error'));
-                });
-            }
-        },
-
-        _.map(['pdf', 'epub', 'mobi'], function(ebookType) {
-            return {
-                name: ebookType+' [book] [output]',
-                description: 'build a book to '+ebookType,
-                options: [
-                    LOG_OPTION
-                ],
-                exec: function(args, kwargs) {
-                    var input = args[0] || process.cwd();
-                    var output = args[1];
-
-                    var book = new Book(input, _.extend({}, {
-                        'logLevel': kwargs.log
-                    }));
-
-                    return book.parse()
-                    .then(function() {
-                        return book.generateFile(output, {
-                            ebookFormat: ebookType
-                        });
-                    })
-                    .then(function(){
-                        console.log('');
-                        console.log(color.green('Done, without error'));
-                    });
-                }
-            };
-        }),
-
-        {
-            name: 'serve [book]',
-            description: 'Build then serve a gitbook from a directory',
-            options: [
-                {
-                    name: 'port',
-                    description: 'Port for server to listen on',
-                    defaults: 4000
-                },
-                {
-                    name: 'lrport',
-                    description: 'Port for livereload server to listen on',
-                    defaults: 35729
-                },
-                {
-                    name: 'watch',
-                    description: 'Enable/disable file watcher',
-                    defaults: true
-                },
-                FORMAT_OPTION,
-                LOG_OPTION
-            ],
-            exec: function(args, kwargs) {
-                var input = args[0] || process.cwd();
-                var server = new Server();
-
-                // Init livereload server
-                var lrServer = tinylr({});
-                var lrPath;
-
-                var generate = function() {
-                    if (server.isRunning()) console.log('Stopping server');
-
-                    return server.stop()
-                    .then(function() {
-                        var book = new Book(input, _.extend({}, {
-                            'config': {
-                                'defaultsPlugins': ['livereload']
-                            },
-                            'logLevel': kwargs.log
-                        }));
-
-                        return book.parse()
-                        .then(function() {
-                            return book.generate(kwargs.format);
-                        })
-                        .thenResolve(book);
-                    })
-                    .then(function(book) {
-                        console.log();
-                        console.log('Starting server ...');
-                        return server.start(book.options.output, kwargs.port)
-                        .then(function() {
-                            console.log('Serving book on http://localhost:'+kwargs.port);
-
-                            if (lrPath) {
-                                // trigger livereload
-                                lrServer.changed({
-                                    body: {
-                                        files: [lrPath]
-                                    }
-                                });
-                            }
-
-                            if (!kwargs.watch) return;
-
-                            return watch(book.root)
-                            .then(function(filepath) {
-                                // set livereload path
-                                lrPath = filepath;
-                                console.log('Restart after change in file', filepath);
-                                console.log('');
-                                return generate();
-                            });
-                        });
-                    });
-                };
-
-                return Q.nfcall(lrServer.listen.bind(lrServer), kwargs.lrport)
-                .then(function() {
-                    console.log('Live reload server started on port:', kwargs.lrport);
-                    console.log('Press CTRL+C to quit ...');
-                    console.log('');
-                    return generate();
-                });
-            }
-        },
-
-        {
-            name: 'install [book]',
-            description: 'install plugins dependencies',
-            exec: function(args) {
-                var input = args[0] || process.cwd();
-
-                var book = new Book(input);
-
-                return book.config.load()
-                .then(function() {
-                    return book.plugins.install();
-                })
-                .then(function(){
-                    console.log('');
-                    console.log(color.green('Done, without error'));
-                });
-            }
-        },
-
-        {
-            name: 'init [directory]',
-            description: 'create files and folders based on contents of SUMMARY.md',
-            exec: function(args) {
-                return initBook(args[0] || process.cwd())
-                .then(function(){
-                    console.log('');
-                    console.log(color.green('Done, without error'));
-                });
-            }
-        }
-    ])
-};

lib/init.js

@@ -1,83 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var path = require('path');
-
-var Book = require('./book');
-var fs = require('./utils/fs');
-
-// Initialize folder structure for a book
-// Read SUMMARY to created the right chapter
-function initBook(root, opts) {
-    var book = new Book(root, opts);
-    var extensionToUse = '.md';
-
-    var chaptersPaths = function(chapters) {
-        return _.reduce(chapters || [], function(accu, chapter) {
-            var o = {
-                title: chapter.title
-            };
-            if (chapter.path) o.path = chapter.path;
-
-            return accu.concat(
-                [o].concat(chaptersPaths(chapter.articles))
-            );
-        }, []);
-    };
-
-    book.log.info.ln('init book at', root);
-    return fs.mkdirp(root)
-    .then(function() {
-        book.log.info.ln('detect structure from SUMMARY (if it exists)');
-        return book.parseSummary();
-    })
-    .fail(function() {
-        return Q();
-    })
-    .then(function() {
-        var summary = book.summaryFile || 'SUMMARY.md';
-        var chapters = book.summary.chapters || [];
-        extensionToUse = path.extname(summary);
-
-        if (chapters.length === 0) {
-            chapters = [
-                {
-                    title: 'Summary',
-                    path: 'SUMMARY'+extensionToUse
-                },
-                {
-                    title: 'Introduction',
-                    path: 'README'+extensionToUse
-                }
-            ];
-        }
-
-        return Q(chaptersPaths(chapters));
-    })
-    .then(function(chapters) {
-        // Create files that don't exist
-        return Q.all(_.map(chapters, function(chapter) {
-            if (!chapter.path) return Q();
-            var absolutePath = path.resolve(book.root, chapter.path);
-
-            return fs.exists(absolutePath)
-            .then(function(exists) {
-                if(exists) {
-                    book.log.info.ln('found', chapter.path);
-                    return;
-                } else {
-                    book.log.info.ln('create', chapter.path);
-                }
-
-                return fs.mkdirp(path.dirname(absolutePath))
-                .then(function() {
-                    return fs.writeFile(absolutePath, '# '+chapter.title+'\n');
-                });
-            });
-        }));
-    })
-    .then(function() {
-        book.log.info.ln('initialization is finished');
-    });
-}
-
-module.exports = initBook;

lib/plugin.js

@@ -1,241 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var path = require('path');
-var url = require('url');
-var fs = require('./utils/fs');
-var resolve = require('resolve');
-var mergeDefaults = require('merge-defaults');
-var jsonschema = require('jsonschema');
-var jsonSchemaDefaults = require('json-schema-defaults');
-
-var version = require('./version');
-
-var PLUGIN_PREFIX = 'gitbook-plugin-';
-
-// Return an absolute name for the plugin (the one on NPM)
-function absoluteName(name) {
-    if (name.indexOf(PLUGIN_PREFIX) === 0) return name;
-    return [PLUGIN_PREFIX, name].join('');
-}
-
-
-var Plugin = function(book, name) {
-    this.book = book;
-    this.name = absoluteName(name);
-    this.packageInfos = {};
-    this.infos = {};
-
-    // Bind methods
-    _.bindAll(this);
-
-    _.each([
-        absoluteName(name),
-        name
-    ], function(_name) {
-        // Load from the book
-        if (this.load(_name, book.root)) return false;
-
-        // Load from default plugins
-        if (this.load(_name, __dirname)) return false;
-    }, this);
-};
-
-// Type of plugins resources
-Plugin.RESOURCES = ['js', 'css'];
-Plugin.HOOKS = [
-    'init', 'finish', 'finish:before', 'config', 'page', 'page:before'
-];
-
-// Return the reduce name for the plugin
-// "gitbook-plugin-test" -> "test"
-// Return a relative name for the plugin (the one on GitBook)
-Plugin.prototype.reducedName = function() {
-    return this.name.replace(PLUGIN_PREFIX, '');
-};
-
-// Load from a name
-Plugin.prototype.load = function(name, baseDir) {
-    try {
-        var res = resolve.sync(name+'/package.json', { basedir: baseDir });
-
-        this.baseDir = path.dirname(res);
-        this.packageInfos = require(res);
-        this.infos = require(resolve.sync(name, { basedir: baseDir }));
-        this.name = this.packageInfos.name;
-
-        return true;
-    } catch (e) {
-        this.packageInfos = {};
-        this.infos = {};
-        return false;
-    }
-};
-
-Plugin.prototype.normalizeResource = function(resource) {
-    // Parse the resource path
-    var parsed = url.parse(resource);
-
-    // This is a remote resource
-    // so we will simply link to using it's URL
-    if (parsed.protocol) {
-        return {
-            'url': resource
-        };
-    }
-
-    // This will be copied over from disk
-    // and shipped with the book's build
-    return { 'path': this.name+'/'+resource };
-};
-
-// Return resources
-Plugin.prototype._getResources = function(base) {
-    base = base;
-    var book = this.infos[base];
-
-    // Compatibility with version 1.x.x
-    if (base == 'website') book = book || this.infos.book;
-
-    // Nothing specified, fallback to default
-    if (!book) {
-        return Q({});
-    }
-
-    // Dynamic function
-    if(typeof book === 'function') {
-        // Call giving it the context of our book
-        return Q().then(book.bind(this.book));
-    }
-
-    // Plain data object
-    return Q(_.cloneDeep(book));
-};
-
-// Normalize resources and return them
-Plugin.prototype.getResources = function(base) {
-    var that = this;
-
-    return this._getResources(base)
-    .then(function(resources) {
-
-        _.each(Plugin.RESOURCES, function(resourceType) {
-            resources[resourceType] = (resources[resourceType] || []).map(that.normalizeResource);
-        });
-
-        return resources;
-    });
-};
-
-// Normalize filters and return them
-Plugin.prototype.getFilters = function() {
-    return this.infos.filters || {};
-};
-
-// Normalize blocks and return them
-Plugin.prototype.getBlocks = function() {
-    return this.infos.blocks || {};
-};
-
-// Test if it's a valid plugin
-Plugin.prototype.isValid = function() {
-    var that = this;
-    var isValid = (
-        this.packageInfos &&
-        this.packageInfos.name &&
-        this.packageInfos.engines &&
-        this.packageInfos.engines.gitbook &&
-        version.satisfies(this.packageInfos.engines.gitbook)
-    );
-
-    // Valid hooks
-    _.each(this.infos.hooks, function(hook, hookName) {
-        if (_.contains(Plugin.HOOKS, hookName)) return;
-        that.book.log.warn.ln('Hook "'+hookName+'"" used by plugin "'+that.packageInfos.name+'" has been removed or is deprecated');
-    });
-
-    return isValid;
-};
-
-// Normalize, validate configuration for this plugin using its schema
-// Throw an error when shcema is not respected
-Plugin.prototype.validateConfig = function(config) {
-    var that = this;
-
-    return Q()
-    .then(function() {
-        var schema = that.packageInfos.gitbook || {};
-        if (!schema) return config;
-
-        // Normalize schema
-        schema.id = '/pluginsConfig.'+that.reducedName();
-        schema.type = 'object';
-
-        // Validate and throw if invalid
-        var v = new jsonschema.Validator();
-        var result = v.validate(config, schema, {
-            propertyName: 'pluginsConfig.'+that.reducedName()
-        });
-
-        // Throw error
-        if (result.errors.length > 0) {
-            throw new Error('Configuration Error: '+result.errors[0].stack);
-        }
-
-        // Insert default values
-        var defaults = jsonSchemaDefaults(schema);
-        return mergeDefaults(config, defaults);
-    });
-};
-
-// Resolve file path
-Plugin.prototype.resolveFile = function(filename) {
-    return path.resolve(this.baseDir, filename);
-};
-
-// Resolve file path
-Plugin.prototype.callHook = function(name, data) {
-    // Our book will be the context to apply
-    var context = this.book;
-
-    var hookFunc = this.infos.hooks? this.infos.hooks[name] : null;
-    data = data || {};
-
-    if (!hookFunc) return Q(data);
-
-    this.book.log.debug.ln('call hook', name);
-    if (!_.contains(Plugin.HOOKS, name)) this.book.log.warn.ln('hook "'+name+'" used by plugin "'+this.name+'" is deprecated, and will be removed in the coming versions');
-
-    return Q()
-    .then(function() {
-        return hookFunc.apply(context, [data]);
-    });
-};
-
-// Copy plugin assets fodler
-Plugin.prototype.copyAssets = function(out, base) {
-    var that = this;
-
-    return this.getResources(base)
-    .get('assets')
-    .then(function(assets) {
-        // Assets are undefined
-        if(!assets) return false;
-
-        return fs.copy(
-            that.resolveFile(assets),
-            out
-        ).then(_.constant(true));
-    }, _.constant(false));
-};
-
-// Get config from book
-Plugin.prototype.getConfig = function() {
-    return this.book.config.get('pluginsConfig.'+this.reducedName(), {});
-};
-
-// Set configuration for this plugin
-Plugin.prototype.setConfig = function(values) {
-    return this.book.config.set('pluginsConfig.'+this.reducedName(), values);
-};
-
-module.exports = Plugin;

lib/pluginslist.js

@@ -1,230 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var npmi = require('npmi');
-var npm = require('npm');
-var semver = require('semver');
-
-var Plugin = require('./plugin');
-var version = require('./version');
-
-var initNPM = _.memoize(function() {
-    return Q.nfcall(npm.load, { silent: true, loglevel: 'silent' });
-});
-
-
-var PluginsList = function(book, plugins) {
-    this.book = book;
-    this.log = this.book.log;
-
-    // List of Plugin objects
-    this.list = [];
-
-    // List of names of failed plugins
-    this.failed = [];
-
-    // Namespaces
-    this.namespaces = _.chain(['website', 'ebook'])
-        .map(function(namespace) {
-            return [
-                namespace,
-                {
-                    html: {},
-                    resources: _.chain(Plugin.RESOURCES)
-                        .map(function(type) {
-                            return [type, []];
-                        })
-                        .object()
-                        .value()
-                }
-            ];
-        })
-        .object()
-        .value();
-
-    // Bind methods
-    _.bindAll(this);
-
-    if (plugins) this.load(plugins);
-};
-
-// return count of plugins
-PluginsList.prototype.count = function() {
-    return this.list.length;
-};
-
-// Add and load a plugin
-PluginsList.prototype.load = function(plugin) {
-    var that = this;
-
-    if (_.isArray(plugin)) {
-        return _.reduce(plugin, function(prev, p) {
-            return prev.then(function() {
-                return that.load(p);
-            });
-        }, Q());
-    }
-    if (_.isObject(plugin) && !(plugin instanceof Plugin)) plugin = plugin.name;
-    if (_.isString(plugin)) plugin = new Plugin(this.book, plugin);
-
-    that.log.info('load plugin', plugin.name, '....');
-    if (!plugin.isValid()) {
-        that.log.info.fail();
-        that.failed.push(plugin.name);
-        return Q();
-    } else {
-        that.log.info.ok();
-
-        // Push in the list
-        that.list.push(plugin);
-    }
-
-    return Q()
-
-    // Validate and normalize configuration
-    .then(function() {
-        var config = plugin.getConfig();
-        return plugin.validateConfig(config);
-    })
-    .then(function(config) {
-        // Update configuration
-        plugin.setConfig(config);
-
-        // Extract filters
-        that.book.template.addFilters(plugin.getFilters());
-
-        // Extract blocks
-        that.book.template.addBlocks(plugin.getBlocks());
-
-        return _.reduce(_.keys(that.namespaces), function(prev, namespaceName) {
-            return prev.then(function() {
-                return plugin.getResources(namespaceName)
-                .then(function(plResources) {
-                    var namespace = that.namespaces[namespaceName];
-
-                    // Extract js and css
-                    _.each(Plugin.RESOURCES, function(resourceType) {
-                        namespace.resources[resourceType] = (namespace.resources[resourceType] || []).concat(plResources[resourceType] || []);
-                    });
-
-                    // Map of html resources by name added by each plugin
-                    _.each(plResources.html || {}, function(value, tag) {
-                        // Turn into function if not one already
-                        if (!_.isFunction(value)) value = _.constant(value);
-
-                        namespace.html[tag] = namespace.html[tag] || [];
-                        namespace.html[tag].push(value);
-                    });
-                });
-            });
-        }, Q());
-    });
-};
-
-// Call a hook
-PluginsList.prototype.hook = function(name, data) {
-    return _.reduce(this.list, function(prev, plugin) {
-        return prev.then(function(ret) {
-            return plugin.callHook(name, ret);
-        });
-    }, Q(data));
-};
-
-// Return a template from a plugin
-PluginsList.prototype.template = function(name) {
-    var withTpl = _.find(this.list, function(plugin) {
-        return (
-            plugin.infos.templates &&
-            plugin.infos.templates[name]
-        );
-    });
-
-    if (!withTpl) return null;
-    return withTpl.resolveFile(withTpl.infos.templates[name]);
-};
-
-// Return an html snippet
-PluginsList.prototype.html = function(namespace, tag, context, options) {
-    var htmlSnippets = this.namespaces[namespace].html[tag];
-    return _.map(htmlSnippets || [], function(code) {
-        return code.call(context, options);
-    }).join('\n');
-};
-
-// Return a resources map for a namespace
-PluginsList.prototype.resources = function(namespace) {
-    return this.namespaces[namespace].resources;
-};
-
-// Install plugins from a book
-PluginsList.prototype.install = function() {
-    var that = this;
-
-    // Remove defaults (no need to install)
-    var plugins = _.reject(that.book.options.plugins, {
-        isDefault: true
-    });
-
-    // Install plugins one by one
-    that.book.log.info.ln(plugins.length+' plugins to install');
-    return _.reduce(plugins, function(prev, plugin) {
-        return prev.then(function() {
-            var fullname = 'gitbook-plugin-'+plugin.name;
-
-            return Q()
-
-            // Resolve version if needed
-            .then(function() {
-                if (plugin.version) return plugin.version;
-
-                that.book.log.info.ln('No version specified, resolve plugin', plugin.name);
-                return initNPM()
-                .then(function() {
-                    return Q.nfcall(npm.commands.view, [fullname+'@*', 'engines'], true);
-                })
-                .then(function(versions) {
-                    return _.chain(versions)
-                        .pairs()
-                        .map(function(v) {
-                            return {
-                                version: v[0],
-                                gitbook: (v[1].engines || {}).gitbook
-                            };
-                        })
-                        .filter(function(v) {
-                            return v.gitbook && version.satisfies(v.gitbook);
-                        })
-                        .sort(function(v1, v2) {
-                            return semver.lt(v1.version, v2.version)? 1 : -1;
-                        })
-                        .pluck('version')
-                        .first()
-                        .value();
-                });
-            })
-
-            // Install the plugin with the resolved version
-            .then(function(version) {
-                if (!version) {
-                    throw 'Found no satisfactory version for plugin '+plugin.name;
-                }
-
-                that.book.log.info.ln('install plugin', plugin.name, 'from npm ('+fullname+') with version', version);
-                return Q.nfcall(npmi, {
-                    'name': fullname,
-                    'version': version,
-                    'path': that.book.root,
-                    'npmLoad': {
-                        'loglevel': 'silent',
-                        'loaded': true,
-                        'prefix': that.book.root
-                    }
-                });
-            })
-            .then(function() {
-                that.book.log.info.ok('plugin', plugin.name, 'installed with success');
-            });
-        });
-    }, Q());
-};
-
-module.exports = PluginsList;

lib/template.js

@@ -1,466 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var path = require('path');
-var nunjucks = require('nunjucks');
-var parsers = require('gitbook-parsers');
-var escapeStringRegexp = require('escape-string-regexp');
-
-var batch = require('./utils/batch');
-var pkg = require('../package.json');
-var defaultBlocks = require('./blocks');
-var BookLoader = require('./conrefs_loader');
-
-// Normalize result from a block
-function normBlockResult(blk) {
-    if (_.isString(blk)) blk = { body: blk };
-    return blk;
-}
-
-
-var TemplateEngine = function(book) {
-    var that = this;
-
-    this.book = book;
-    this.log = this.book.log;
-
-    // Template loader
-    this.loader = new BookLoader(book, {
-        // Replace shortcuts in imported files
-        interpolate: function(filepath, source) {
-            var parser = parsers.get(path.extname(filepath));
-            var type = parser? parser.name : null;
-
-            return  that.applyShortcuts(type, source);
-        }
-    });
-
-    // Nunjucks env
-    this.env = new nunjucks.Environment(
-        this.loader,
-        {
-            // Escaping is done after by the markdown parser
-            autoescape: false,
-
-            // Tags
-            tags: {
-                blockStart: '{%',
-                blockEnd: '%}',
-                variableStart: '{{',
-                variableEnd: '}}',
-                commentStart: '{###',
-                commentEnd: '###}'
-            }
-        }
-    );
-
-    // List of tags shortcuts
-    this.shortcuts = [];
-
-    // Map of blocks bodies (that requires post-processing)
-    this.blockBodies = {};
-
-    // Map of added blocks
-    this.blocks = {};
-
-    // Bind methods
-    _.bindAll(this);
-
-    // Add default blocks
-    this.addBlocks(defaultBlocks);
-};
-
-// Process the result of block in a context
-TemplateEngine.prototype.processBlock = function(blk) {
-    blk = _.defaults(blk, {
-        parse: false,
-        post: undefined
-    });
-    blk.id = _.uniqueId('blk');
-
-    var toAdd = (!blk.parse) || (blk.post !== undefined);
-
-    // Add to global map
-    if (toAdd) this.blockBodies[blk.id] = blk;
-
-    // Parsable block, just return it
-    if (blk.parse) {
-        return blk.body;
-    }
-
-    // Return it as a position marker
-    return '@%@'+blk.id+'@%@';
-};
-
-// Replace position markers of blocks by body after processing
-// This is done to avoid that markdown/asciidoc processer parse the block content
-TemplateEngine.prototype.replaceBlocks = function(content) {
-    var that = this;
-
-    return content.replace(/\@\%\@([\s\S]+?)\@\%\@/g, function(match, key) {
-        var blk = that.blockBodies[key];
-        if (!blk) return match;
-
-        var body = blk.body;
-
-        return body;
-    });
-};
-
-// Bind a function to a context
-TemplateEngine.prototype.bindContext = function(func) {
-    var that = this;
-
-    return function() {
-        var ctx = {
-            ctx: this.ctx,
-            book: that.book,
-            generator: that.book.options.generator
-        };
-
-        return func.apply(ctx, arguments);
-    };
-};
-
-// Add filter
-TemplateEngine.prototype.addFilter = function(filterName, func) {
-    try {
-        this.env.getFilter(filterName);
-        this.log.warn.ln('conflict in filters, \''+filterName+'\' is already set');
-        return false;
-    } catch(e) {
-        // Filter doesn't exist
-    }
-
-    this.log.debug.ln('add filter \''+filterName+'\'');
-    this.env.addFilter(filterName, this.bindContext(function() {
-        var ctx = this;
-        var args = Array.prototype.slice.apply(arguments);
-        var callback = _.last(args);
-
-        Q()
-        .then(function() {
-            return func.apply(ctx, args.slice(0, -1));
-        })
-        .nodeify(callback);
-    }), true);
-    return true;
-};
-
-// Add multiple filters
-TemplateEngine.prototype.addFilters = function(filters) {
-    _.each(filters, function(filter, name) {
-        this.addFilter(name, filter);
-    }, this);
-};
-
-// Return nunjucks extension name of a block
-TemplateEngine.prototype.blockExtName = function(name) {
-    return 'Block'+name+'Extension';
-};
-
-// Test if a block is defined
-TemplateEngine.prototype.hasBlock = function(name) {
-    return this.env.hasExtension(this.blockExtName(name));
-};
-
-// Remove a block
-TemplateEngine.prototype.removeBlock = function(name) {
-    if (!this.hasBlock(name)) return;
-
-    // Remove nunjucks extension
-    this.env.removeExtension(this.blockExtName(name));
-
-    // Cleanup shortcuts
-    this.shortcuts = _.reject(this.shortcuts, {
-        block: name
-    });
-};
-
-// Add a block
-TemplateEngine.prototype.addBlock = function(name, block) {
-    var that = this, Ext, extName;
-
-    if (_.isFunction(block)) block = { process: block };
-
-    block = _.defaults(block || {}, {
-        shortcuts: [],
-        end: 'end'+name,
-        process: _.identity,
-        blocks: []
-    });
-
-    extName = this.blockExtName(name);
-
-    if (this.hasBlock(name) && !defaultBlocks[name]) {
-        this.log.warn.ln('conflict in blocks, \''+name+'\' is already defined');
-    }
-
-    // Cleanup previous block
-    this.removeBlock(name);
-
-    this.log.debug.ln('add block \''+name+'\'');
-    this.blocks[name] = block;
-
-    Ext = function () {
-        this.tags = [name];
-
-        this.parse = function(parser, nodes) {
-            var body = null;
-            var lastBlockName = null;
-            var lastBlockArgs = null;
-            var allBlocks = block.blocks.concat([block.end]);
-            var subbodies = {};
-
-            var tok = parser.nextToken();
-            var args = parser.parseSignature(null, true);
-            parser.advanceAfterBlockEnd(tok.value);
-
-            while (1) {
-                // Read body
-                var currentBody = parser.parseUntilBlocks.apply(parser, allBlocks);
-
-                // Handle body with previous block name and args
-                if (lastBlockName) {
-                    subbodies[lastBlockName] = subbodies[lastBlockName] || [];
-                    subbodies[lastBlockName].push({
-                        body: currentBody,
-                        args: lastBlockArgs
-                    });
-                } else {
-                    body = currentBody;
-                }
-
-                // Read new block
-                lastBlockName = parser.peekToken().value;
-                if (lastBlockName == block.end) {
-                    break;
-                }
-
-                // Parse signature and move to the end of the block
-                lastBlockArgs = parser.parseSignature(null, true);
-                parser.advanceAfterBlockEnd(lastBlockName);
-            }
-            parser.advanceAfterBlockEnd();
-
-            var bodies = [body];
-            _.each(block.blocks, function(blockName) {
-                subbodies[blockName] = subbodies[blockName] || [];
-                if (subbodies[blockName].length === 0) {
-                    subbodies[blockName].push({
-                        args: new nodes.NodeList(),
-                        body: new nodes.NodeList()
-                    });
-                }
-
-                bodies.push(subbodies[blockName][0].body);
-            });
-
-            return new nodes.CallExtensionAsync(this, 'run', args, bodies);
-        };
-
-        this.run = function(context) {
-            var args = Array.prototype.slice.call(arguments, 1);
-            var callback = args.pop();
-
-            // Extract blocks
-            var blocks = args
-                .concat([])
-                .slice(-block.blocks.length);
-
-            // Eliminate blocks from list
-            if (block.blocks.length > 0) args = args.slice(0, -block.blocks.length);
-
-            // Extract main body and kwargs
-            var body = args.pop();
-            var kwargs = _.isObject(_.last(args))? args.pop() : {};
-
-            // Extract blocks body
-            var _blocks =  _.map(block.blocks, function(blockName, i){
-                return {
-                    name: blockName,
-                    body: blocks[i]()
-                };
-            });
-
-            Q()
-            .then(function() {
-                return that.applyBlock(name, {
-                    body: body(),
-                    args: args,
-                    kwargs: kwargs,
-                    blocks: _blocks
-                }, context);
-            })
-
-            // process the block returned
-            .then(that.processBlock)
-            .nodeify(callback);
-        };
-    };
-
-    // Add the Extension
-    this.env.addExtension(extName, new Ext());
-
-    // Add shortcuts
-    if (!_.isArray(block.shortcuts)) block.shortcuts = [block.shortcuts];
-    _.each(block.shortcuts, function(shortcut) {
-        this.log.debug.ln('add template shortcut from \''+shortcut.start+'\' to block \''+name+'\' for parsers ', shortcut.parsers);
-        this.shortcuts.push({
-            block: name,
-            parsers: shortcut.parsers,
-            start: shortcut.start,
-            end: shortcut.end,
-            tag: {
-                start: name,
-                end: block.end
-            }
-        });
-    }, this);
-};
-
-// Add multiple blocks
-TemplateEngine.prototype.addBlocks = function(blocks) {
-    _.each(blocks, function(block, name) {
-        this.addBlock(name, block);
-    }, this);
-};
-
-// Apply a block to some content
-// This method result depends on the type of block (async or sync)
-TemplateEngine.prototype.applyBlock = function(name, blk, ctx) {
-    var func, block, r;
-
-    block = this.blocks[name];
-    if (!block) throw new Error('Block not found \''+name+'\'');
-    if (_.isString(blk)) {
-        blk = {
-            body: blk
-        };
-    }
-
-    blk = _.defaults(blk, {
-        args: [],
-        kwargs: {},
-        blocks: []
-    });
-
-    // Bind and call block processor
-    func = this.bindContext(block.process);
-    r = func.call(ctx || {}, blk);
-
-    if (Q.isPromise(r)) return r.then(normBlockResult);
-    else return normBlockResult(r);
-};
-
-// Apply a shortcut to a string
-TemplateEngine.prototype._applyShortcut = function(parser, content, shortcut) {
-    if (!_.contains(shortcut.parsers, parser)) return content;
-    var regex = new RegExp(
-        escapeStringRegexp(shortcut.start) + '([\\s\\S]*?[^\\$])' + escapeStringRegexp(shortcut.end),
-       'g'
-    );
-    return content.replace(regex, function(all, match) {
-        return '{% '+shortcut.tag.start+' %}'+ match + '{% '+shortcut.tag.end+' %}';
-    });
-};
-
-// Apply all shortcuts to some template string
-TemplateEngine.prototype.applyShortcuts = function(type, content) {
-    return _.reduce(this.shortcuts, _.partial(this._applyShortcut.bind(this), type), content);
-};
-
-// Render a string from the book
-TemplateEngine.prototype.renderString = function(content, context, options) {
-    context = _.extend({}, context, {
-        // Variables from book.json
-        book: this.book.options.variables,
-
-        // Complete book.json
-        config: this.book.options,
-
-        // infos about gitbook
-        gitbook: {
-            version: pkg.version,
-            generator: this.book.options.generator
-        }
-    });
-    options = _.defaults(options || {}, {
-        path: null,
-        type: null
-    });
-    if (options.path) options.path = this.book.resolve(options.path);
-    if (!options.type && options.path) {
-        var parser = parsers.get(path.extname(options.path));
-        options.type = parser? parser.name : null;
-    }
-
-    // Replace shortcuts
-    content = this.applyShortcuts(options.type, content);
-
-    return Q.nfcall(this.env.renderString.bind(this.env), content, context, options)
-    .fail(function(err) {
-        if (_.isString(err)) err = new Error(err);
-        err.message = err.message.replace(/^Error: /, '');
-
-        throw err;
-    });
-};
-
-// Render a file from the book
-TemplateEngine.prototype.renderFile = function(filename) {
-    var that = this;
-
-    return that.book.readFile(filename)
-    .then(function(content) {
-        return that.renderString(content, {}, {
-            path: filename
-        });
-    });
-};
-
-// Render a page from the book
-TemplateEngine.prototype.renderPage = function(page) {
-    var that = this;
-
-    return that.book.statFile(page.path)
-    .then(function(stat) {
-        var context = {
-            // infos about the file
-            file: {
-                path: page.path,
-                mtime: stat.mtime
-            }
-        };
-
-        return that.renderString(page.content, context, {
-            path: page.path,
-            type: page.type
-        });
-    });
-};
-
-// Post process content
-TemplateEngine.prototype.postProcess = function(content) {
-    var that = this;
-
-    return Q(content)
-    .then(that.replaceBlocks)
-    .then(function(_content) {
-        return batch.execEach(that.blockBodies, {
-            max: 20,
-            fn: function(blk, blkId) {
-                return Q()
-                .then(function() {
-                    if (!blk.post) return Q();
-                    return blk.post();
-                })
-                .then(function() {
-                    delete that.blockBodies[blkId];
-                });
-            }
-        })
-        .thenResolve(_content);
-    });
-};
-
-module.exports = TemplateEngine;

lib/utils/batch.js

@@ -1,52 +0,0 @@
-var Q = require("q");
-var _ = require("lodash");
-
-// Execute a method for all element
-function execEach(items, options) {
-    if (_.size(items) === 0) return Q();
-    var concurrents = 0, d = Q.defer(), pending = [];
-
-    options = _.defaults(options || {}, {
-        max: 100,
-        fn: function() {}
-    });
-
-
-    function startItem(item, i) {
-        if (concurrents >= options.max) {
-            pending.push([item, i]);
-            return;
-        }
-
-        concurrents++;
-        Q()
-        .then(function() {
-            return options.fn(item, i);
-        })
-        .then(function() {
-            concurrents--;
-
-            // Next pending
-            var next = pending.shift();
-
-            if (concurrents === 0 && !next) {
-                d.resolve();
-            } else if (next) {
-                startItem.apply(null, next);
-            }
-        })
-        .fail(function(err) {
-            pending = [];
-            d.reject(err);
-        });
-    }
-
-    _.each(items, startItem);
-
-    return d.promise;
-}
-
-module.exports = {
-    execEach: execEach
-};
-

lib/utils/fs.js

@@ -1,193 +0,0 @@
-var _ = require('lodash');
-var Q = require('q');
-var tmp = require('tmp');
-var path = require('path');
-var fs = require('graceful-fs');
-var fsExtra = require('fs-extra');
-var Ignore = require('fstream-ignore');
-
-var fsUtils = {
-    tmp: {
-        file: function(opt) {
-            return Q.nfcall(tmp.file.bind(tmp), opt).get(0);
-        },
-        dir: function() {
-            return Q.nfcall(tmp.dir.bind(tmp)).get(0);
-        }
-    },
-    list: listFiles,
-    stat: Q.denodeify(fs.stat),
-    readdir: Q.denodeify(fs.readdir),
-    readFile: Q.denodeify(fs.readFile),
-    writeFile: writeFile,
-    writeStream: writeStream,
-    mkdirp: Q.denodeify(fsExtra.mkdirp),
-    copy: Q.denodeify(fsExtra.copy),
-    remove: Q.denodeify(fsExtra.remove),
-    symlink: Q.denodeify(fsExtra.symlink),
-    exists: function(path) {
-        var d = Q.defer();
-        fs.exists(path, d.resolve);
-        return d.promise;
-    },
-    findFile: findFile,
-    existsSync: fs.existsSync.bind(fs),
-    readFileSync: fs.readFileSync.bind(fs),
-    clean: cleanFolder,
-    getUniqueFilename: getUniqueFilename
-};
-
-// Write a file
-function writeFile(filename, data, options) {
-    var d = Q.defer();
-
-    try {
-        fs.writeFileSync(filename, data, options);
-    } catch(err) {
-        d.reject(err);
-    }
-    d.resolve();
-
-
-    return d.promise;
-}
-
-// Write a stream to a file
-function writeStream(filename, st) {
-    var d = Q.defer();
-
-    var wstream = fs.createWriteStream(filename);
-
-    wstream.on('finish', function () {
-        d.resolve();
-    });
-    wstream.on('error', function (err) {
-        d.reject(err);
-    });
-
-    st.on('error', function(err) {
-        d.reject(err);
-    });
-
-    st.pipe(wstream);
-
-    return d.promise;
-}
-
-// Find a filename available
-function getUniqueFilename(base, filename) {
-    if (!filename) {
-        filename = base;
-        base = '/';
-    }
-
-    filename = path.resolve(base, filename);
-    var ext = path.extname(filename);
-    filename = path.join(path.dirname(filename), path.basename(filename, ext));
-
-    var _filename = filename+ext;
-
-    var i = 0;
-    while (fs.existsSync(filename)) {
-        _filename = filename+'_'+i+ext;
-        i = i + 1;
-    }
-
-    return path.relative(base, _filename);
-}
-
-
-// List files in a directory
-function listFiles(root, options) {
-    options = _.defaults(options || {}, {
-        ignoreFiles: [],
-        ignoreRules: []
-    });
-
-    var d = Q.defer();
-
-    // Our list of files
-    var files = [];
-
-    var ig = Ignore({
-        path: root,
-        ignoreFiles: options.ignoreFiles
-    });
-
-    // Add extra rules to ignore common folders
-    ig.addIgnoreRules(options.ignoreRules, '__custom_stuff');
-
-    // Push each file to our list
-    ig.on('child', function (c) {
-        files.push(
-            c.path.substr(c.root.path.length + 1) + (c.props.Directory === true ? '/' : '')
-        );
-    });
-
-    ig.on('end', function() {
-        // Normalize paths on Windows
-        if(process.platform === 'win32') {
-            return d.resolve(files.map(function(file) {
-                return file.replace(/\\/g, '/');
-            }));
-        }
-
-        // Simply return paths otherwise
-        return d.resolve(files);
-    });
-
-    ig.on('error', d.reject);
-
-    return d.promise;
-}
-
-// Clean a folder without removing .git and .svn
-// Creates it if non existant
-function cleanFolder(root) {
-    if (!fs.existsSync(root)) return fsUtils.mkdirp(root);
-
-    return listFiles(root, {
-        ignoreFiles: [],
-        ignoreRules: [
-            // Skip Git and SVN stuff
-            '.git/',
-            '.svn/'
-        ]
-    })
-    .then(function(files) {
-        var d = Q.defer();
-
-        _.reduce(files, function(prev, file, i) {
-            return prev.then(function() {
-                var _file = path.join(root, file);
-
-                d.notify({
-                    i: i+1,
-                    count: files.length,
-                    file: _file
-                });
-                return fsUtils.remove(_file);
-            });
-        }, Q())
-        .then(function() {
-            d.resolve();
-        }, function(err) {
-            d.reject(err);
-        });
-
-        return d.promise;
-    });
-}
-
-// Find a file in a folder (case incensitive)
-// Return the real filename
-function findFile(root, filename) {
-    return Q.nfcall(fs.readdir, root)
-    .then(function(files) {
-        return _.find(files, function(file) {
-            return (file.toLowerCase() == filename.toLowerCase());
-        });
-    });
-}
-
-module.exports = fsUtils;

lib/utils/git.js

@@ -1,127 +0,0 @@
-var  Q = require('q');
-var _ = require('lodash');
-var path = require('path');
-var crc = require('crc');
-var exec = Q.denodeify(require('child_process').exec);
-var URI = require('urijs');
-var pathUtil = require('./path');
-
-var fs = require('./fs');
-
-var GIT_PREFIX = 'git+';
-var GIT_TMP = null;
-
-
-// Check if an url is a git dependency url
-function checkGitUrl(giturl) {
-    return (giturl.indexOf(GIT_PREFIX) === 0);
-}
-
-// Validates a SHA in hexadecimal
-function validateSha(str) {
-    return (/[0-9a-f]{40}/).test(str);
-}
-
-// Parse and extract infos
-function parseGitUrl(giturl) {
-    var ref, uri, fileParts, filepath;
-
-    if (!checkGitUrl(giturl)) return null;
-    giturl = giturl.slice(GIT_PREFIX.length);
-
-    uri = new URI(giturl);
-    ref = uri.fragment() || 'master';
-    uri.fragment(null);
-
-    // Extract file inside the repo (after the .git)
-    fileParts =uri.path().split('.git');
-    filepath = fileParts.length > 1? fileParts.slice(1).join('.git') : '';
-    if (filepath[0] == '/') filepath = filepath.slice(1);
-
-    // Recreate pathname without the real filename
-    uri.path(_.first(fileParts)+'.git');
-
-    return {
-        host: uri.toString(),
-        ref: ref || 'master',
-        filepath: filepath
-    };
-}
-
-// Clone a git repo from a specific ref
-function cloneGitRepo(host, ref) {
-    var isBranch = false;
-
-    ref = ref || 'master';
-    if (!validateSha(ref)) isBranch = true;
-
-    return Q()
-
-    // Create temporary folder to store git repos
-    .then(function() {
-        if (GIT_TMP) return;
-        return fs.tmp.dir()
-            .then(function(_tmp) {
-                GIT_TMP = _tmp;
-            });
-    })
-
-    // Return or clone the git repo
-    .then(function() {
-        // Unique ID for repo/ref combinaison
-        var repoId = crc.crc32(host+'#'+ref).toString(16);
-
-        // Absolute path to the folder
-        var repoPath = path.resolve(GIT_TMP, repoId);
-
-        return fs.exists(repoPath)
-            .then(function(doExists) {
-                if (doExists) return;
-
-                // Clone repo
-                return exec('git clone '+host+' '+repoPath)
-                .then(function() {
-                    return exec('git checkout '+ref, { cwd: repoPath });
-                });
-            })
-            .thenResolve(repoPath);
-    });
-}
-
-// Get file from a git repo
-function resolveFileFromGit(giturl) {
-    if (_.isString(giturl)) giturl = parseGitUrl(giturl);
-    if (!giturl) return Q(null);
-
-    // Clone or get from cache
-    return cloneGitRepo(giturl.host, giturl.ref)
-    .then(function(repo) {
-
-        // Resolve relative path
-        return path.resolve(repo, giturl.filepath);
-    });
-}
-
-// Return root of git repo from a filepath
-function resolveGitRoot(filepath) {
-    var relativeToGit, repoId;
-
-    // No git repo cloned, or file is not in a git repository
-    if (!GIT_TMP || !pathUtil.isInRoot(GIT_TMP, filepath)) return null;
-
-    // Extract first directory (is the repo id)
-    relativeToGit = path.relative(GIT_TMP, filepath);
-    repoId = _.first(relativeToGit.split(path.sep));
-    if (!repoId) return;
-
-    // Return an absolute file
-    return path.resolve(GIT_TMP, repoId);
-}
-
-
-module.exports = {
-    checkUrl: checkGitUrl,
-    parseUrl: parseGitUrl,
-    resolveFile: resolveFileFromGit,
-    resolveRoot: resolveGitRoot
-};

lib/utils/i18n.js

@@ -1,80 +0,0 @@
-var _ = require('lodash');
-var path = require('path');
-var fs = require('fs');
-
-var i18n = require('i18n');
-
-var I18N_PATH = path.resolve(__dirname, '../../theme/i18n/');
-var DEFAULT_LANGUAGE = 'en';
-var LOCALES = _.map(fs.readdirSync(I18N_PATH), function(lang) {
-    return path.basename(lang, '.json');
-});
-
-i18n.configure({
-    locales: LOCALES,
-    directory: I18N_PATH,
-    defaultLocale: DEFAULT_LANGUAGE,
-    updateFiles: false
-});
-
-function compareLocales(lang, locale) {
-    var langMain = _.first(lang.split('-'));
-    var langSecond = _.last(lang.split('-'));
-
-    var localeMain = _.first(locale.split('-'));
-    var localeSecond = _.last(locale.split('-'));
-
-    if (locale == lang) return 100;
-    if (localeMain == langMain) return 50;
-    if (localeSecond == langSecond) return 20;
-    return 0;
-}
-
-var normalizeLanguage = _.memoize(function(lang) {
-    var language = _.chain(LOCALES)
-        .values()
-        .map(function(locale) {
-            return {
-                locale: locale,
-                score: compareLocales(lang, locale)
-            };
-        })
-        .filter(function(lang) {
-            return lang.score > 0;
-        })
-        .sortBy('score')
-        .pluck('locale')
-        .last()
-        .value();
-    return language || lang;
-});
-
-function translate(locale, phrase) {
-    var args = Array.prototype.slice.call(arguments, 2);
-
-    return i18n.__.apply({}, [{
-        locale: locale,
-        phrase: phrase
-    }].concat(args));
-}
-
-function getCatalog(locale) {
-    locale = normalizeLanguage(locale);
-    return i18n.getCatalog(locale);
-}
-
-function getLocales() {
-    return LOCALES;
-}
-
-function hasLocale(locale) {
-    return _.contains(LOCALES, locale);
-}
-
-module.exports = {
-    __: translate,
-    normalizeLanguage: normalizeLanguage,
-    getCatalog: getCatalog,
-    getLocales: getLocales,
-    hasLocale: hasLocale
-};

lib/utils/images.js

@@ -1,37 +0,0 @@
-var _ = require("lodash");
-var Q = require("q");
-var fs = require("./fs");
-var spawn = require("spawn-cmd").spawn;
-
-// Convert a svg file
-var convertSVG = function(source, dest, options) {
-    if (!fs.existsSync(source)) return Q.reject(new Error("File doesn't exist: "+source));
-    var d = Q.defer();
-
-    options = _.defaults(options || {}, {
-
-    });
-
-    //var command = shellescape(["svgexport", source, dest]);
-    var child = spawn("svgexport", [source, dest]);
-
-    child.on("error", function(error) {
-        if (error.code == "ENOENT") error = new Error("Need to install \"svgexport\" using \"npm install svgexport -g\"");
-        return d.reject(error);
-    });
-
-    child.on("close", function(code) {
-        if (code === 0 && fs.existsSync(dest)) {
-            d.resolve();
-        } else {
-            d.reject(new Error("Error converting "+source+" into "+dest));
-        }
-    });
-
-    return d.promise;
-};
-
-module.exports = {
-    convertSVG: convertSVG,
-    INVALID: [".svg"]
-};

lib/utils/links.js

@@ -1,82 +0,0 @@
-var url = require("url");
-var path = require("path");
-
-// Is the link an external link
-var isExternal = function(href) {
-    try {
-        return Boolean(url.parse(href).protocol);
-    } catch(err) { }
-
-    return false;
-};
-
-// Return true if the link is relative
-var isRelative = function(href) {
-    try {
-        var parsed = url.parse(href);
-
-        return !!(!parsed.protocol && parsed.path);
-    } catch(err) {}
-
-    return true;
-};
-
-// Return true if the link is an achor
-var isAnchor = function(href) {
-    try {
-        var parsed = url.parse(href);
-        return !!(!parsed.protocol && !parsed.path && parsed.hash);
-    } catch(err) {}
-
-    return false;
-};
-
-// Normalize a path to be a link
-var normalizeLink = function(s) {
-    return s.replace(/\\/g, "/");
-};
-
-// Relative to absolute path
-// dir: directory parent of the file currently in rendering process
-// outdir: directory parent from the html output
-
-var toAbsolute = function(_href, dir, outdir) {
-    if (isExternal(_href)) return _href;
-
-    // Path "_href" inside the base folder
-    var hrefInRoot = path.normalize(path.join(dir, _href));
-    if (_href[0] == "/") hrefInRoot = path.normalize(_href.slice(1));
-
-    // Make it relative to output
-    _href = path.relative(outdir, hrefInRoot);
-
-    // Normalize windows paths
-    _href = normalizeLink(_href);
-
-    return _href;
-};
-
-// Join links
-var join = function() {
-    var _href = path.join.apply(path, arguments);
-
-    return normalizeLink(_href);
-};
-
-// Change extension
-var changeExtension = function(filename, newext) {
-    return path.join(
-        path.dirname(filename),
-        path.basename(filename, path.extname(filename))+newext
-    );
-};
-
-module.exports = {
-    isAnchor: isAnchor,
-    isRelative: isRelative,
-    isExternal: isExternal,
-    toAbsolute: toAbsolute,
-    join: join,
-    changeExtension: changeExtension,
-    normalize: normalizeLink
-};

lib/utils/logger.js

@@ -1,102 +0,0 @@
-var _ = require("lodash");
-var util = require("util");
-var color = require("bash-color");
-
-var LEVELS = {
-    DEBUG: 0,
-    INFO: 1,
-    WARN: 2,
-    ERROR: 3,
-    DISABLED: 10
-};
-
-var COLORS = {
-    DEBUG: color.purple,
-    INFO: color.cyan,
-    WARN: color.yellow,
-    ERROR: color.red
-};
-
-module.exports = function(_write, logLevel) {
-    var logger = {};
-    var lastChar = "\n";
-    if (_.isString(logLevel)) logLevel = LEVELS[logLevel.toUpperCase()];
-
-    // Write a simple message
-    logger.write = function(msg) {
-        msg = msg.toString();
-        lastChar = _.last(msg);
-        return _write(msg);
-    };
-
-    // Format a message
-    logger.format = function() {
-        return util.format.apply(util, arguments);
-    };
-
-    // Write a line
-    logger.writeLn = function(msg) {
-        return this.write((msg || "")+"\n");
-    };
-
-    // Write a message with a certain level
-    logger.log = function(level) {
-        if (level < logLevel) return;
-
-        var levelKey = _.findKey(LEVELS, function(v) { return v == level; });
-        var args = Array.prototype.slice.apply(arguments, [1]);
-        var msg = logger.format.apply(logger, args);
-
-        if (lastChar == "\n") {
-            msg = COLORS[levelKey](levelKey.toLowerCase()+":")+" "+msg;
-        }
-
-        return logger.write(msg);
-    };
-    logger.logLn = function() {
-        if (lastChar != "\n") logger.write("\n");
-
-        var args = Array.prototype.slice.apply(arguments);
-        args.push("\n");
-        logger.log.apply(logger, args);
-    };
-
-    // Write a OK
-    logger.ok = function(level) {
-        var args = Array.prototype.slice.apply(arguments, [1]);
-        var msg = logger.format.apply(logger, args);
-        if (arguments.length > 1) {
-            logger.logLn(level, color.green(">> ") + msg.trim().replace(/\n/g, color.green("\n>> ")));
-        } else {
-            logger.log(level, color.green("OK"), "\n");
-        }
-    };
-
-    // Write an "FAIL"
-    logger.fail = function(level) {
-        return logger.log(level, color.red("ERROR")+"\n");
-    };
-
-    _.each(_.omit(LEVELS, "DISABLED"), function(level, levelKey) {
-        levelKey = levelKey.toLowerCase();
-
-        logger[levelKey] = _.partial(logger.log, level);
-        logger[levelKey].ln = _.partial(logger.logLn, level);
-        logger[levelKey].ok = _.partial(logger.ok, level);
-        logger[levelKey].fail = _.partial(logger.fail, level);
-        logger[levelKey].promise = function(p) {
-            return p.
-            then(function(st) {
-                logger[levelKey].ok();
-                return st;
-            }, function(err) {
-                logger[levelKey].fail();
-                throw err;
-            });
-        };
-    });
-
-    return logger;
-};
-module.exports.LEVELS = LEVELS;
-module.exports.COLORS = COLORS;

lib/utils/navigation.js

@@ -1,79 +0,0 @@
-var _ = require("lodash");
-
-// Cleans up an article/chapter object
-// remove "articles" attributes
-function clean(obj) {
-    return obj && _.omit(obj, ["articles"]);
-}
-
-function flattenChapters(chapters) {
-    return _.reduce(chapters, function(accu, chapter) {
-        return accu.concat([clean(chapter)].concat(flattenChapters(chapter.articles)));
-    }, []);
-}
-
-// Returns from a summary a map of
-/*
-    {
-        "file/path.md": {
-            prev: ...,
-            next: ...,
-        },
-        ...
-    }
-*/
-function navigation(summary, files) {
-    // Support single files as well as list
-    files = _.isArray(files) ? files : (_.isString(files) ? [files] : null);
-
-    // List of all navNodes
-    // Flatten chapters
-    var navNodes = flattenChapters(summary.chapters);
-
-    // Mapping of prev/next for a give path
-    var mapping = _.chain(navNodes)
-    .map(function(current, i) {
-        var prev = null, next = null;
-
-        // Skip if no path
-        if(!current.exists) return null;
-
-        // Find prev
-        prev = _.chain(navNodes.slice(0, i))
-            .reverse()
-            .find(function(node) {
-                return node.exists && !node.external;
-            })
-            .value();
-
-        // Find next
-        next = _.chain(navNodes.slice(i+1))
-            .find(function(node) {
-                return node.exists && !node.external;
-            })
-            .value();
-
-        return [current.path, {
-            index: i,
-            title: current.title,
-            introduction: current.introduction,
-            prev: prev,
-            next: next,
-            level: current.level,
-        }];
-    })
-    .compact()
-    .object()
-    .value();
-
-    // Filter for only files we want
-    if(files) {
-        return _.pick(mapping, files);
-    }
-
-    return mapping;
-}
-
-
-// Exports
-module.exports = navigation;

lib/utils/page.js

@@ -1,394 +0,0 @@
-var Q = require('q');
-var _ = require('lodash');
-var url = require('url');
-var path = require('path');
-var cheerio = require('cheerio');
-var domSerializer = require('dom-serializer');
-var request = require('request');
-var crc = require('crc');
-var slug = require('github-slugid');
-
-var links = require('./links');
-var imgUtils = require('./images');
-var fs = require('./fs');
-var batch = require('./batch');
-
-var parsableExtensions = require('gitbook-parsers').extensions;
-
-// Map of images that have been converted
-var imgConversionCache = {};
-
-// Render a cheerio dom as html
-function renderDom($, dom, options) {
-    if (!dom && $._root && $._root.children) {
-        dom = $._root.children;
-    }
-
-    options = options|| dom.options || $._options;
-    return domSerializer(dom, options);
-}
-
-function replaceText($, el, search, replace, text_only ) {
-    return $(el).each(function(){
-        var node = this.firstChild,
-            val,
-            new_val,
-
-            // Elements to be removed at the end.
-            remove = [];
-
-        // Only continue if firstChild exists.
-        if ( node ) {
-
-            // Loop over all childNodes.
-            while (node) {
-
-                // Only process text nodes.
-                if ( node.nodeType === 3 ) {
-
-                    // The original node value.
-                    val = node.nodeValue;
-
-                    // The new value.
-                    new_val = val.replace( search, replace );
-
-                    // Only replace text if the new value is actually different!
-                    if ( new_val !== val ) {
-
-                        if ( !text_only && /</.test( new_val ) ) {
-                            // The new value contains HTML, set it in a slower but far more
-                            // robust way.
-                            $(node).before( new_val );
-
-                            // Don't remove the node yet, or the loop will lose its place.
-                            remove.push( node );
-                        } else {
-                            // The new value contains no HTML, so it can be set in this
-                            // very fast, simple way.
-                            node.nodeValue = new_val;
-                        }
-                    }
-                }
-
-                node = node.nextSibling;
-            }
-        }
-
-        // Time to remove those elements!
-        if (remove.length) $(remove).remove();
-    });
-}
-
-function pregQuote( str ) {
-    return (str+'').replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, '\\$1');
-}
-
-
-// Adapt an html snippet to be relative to a base folder
-function normalizeHtml(src, options) {
-    var $ = cheerio.load(src, {
-        // We should parse html without trying to normalize too much
-        xmlMode: false,
-
-        // SVG need some attributes to use uppercases
-        lowerCaseAttributeNames: false,
-        lowerCaseTags: false
-    });
-    var toConvert = [];
-    var svgContent = {};
-    var outputRoot = options.book.options.output;
-
-    imgConversionCache[outputRoot] = imgConversionCache[outputRoot] || {};
-
-    // Find svg images to extract and process
-    if (options.convertImages) {
-        $('svg').each(function() {
-            var content = renderDom($, $(this));
-            var svgId = _.uniqueId('svg');
-            var dest = svgId+'.svg';
-
-            // Generate filename
-            dest = '/'+fs.getUniqueFilename(outputRoot, dest);
-
-            svgContent[dest] = '<?xml version="1.0" encoding="UTF-8"?>'+content;
-            $(this).replaceWith($('<img>').attr('src', dest));
-        });
-    }
-
-    // Generate ID for headings
-    $('h1,h2,h3,h4,h5,h6').each(function() {
-        if ($(this).attr('id')) return;
-
-        $(this).attr('id', slug($(this).text()));
-    });
-
-    // Find images to normalize
-    $('img').each(function() {
-        var origin;
-        var src = $(this).attr('src');
-
-        if (!src) return;
-        var isExternal = links.isExternal(src);
-
-        // Transform as relative to the bases
-        if (links.isRelative(src)) {
-            src = links.toAbsolute(src, options.base, options.output);
-        }
-
-        // Convert if needed
-        if (options.convertImages) {
-            // If image is external and ebook, then downlaod the images
-            if (isExternal) {
-                origin = src;
-                src = '/'+crc.crc32(origin).toString(16)+path.extname(url.parse(origin).pathname);
-                src = links.toAbsolute(src, options.base, options.output);
-                isExternal = false;
-            }
-
-            var ext = path.extname(src);
-            var srcAbs = links.join('/', options.base, src);
-
-            // Test image extension
-            if (_.contains(imgUtils.INVALID, ext)) {
-                if (imgConversionCache[outputRoot][srcAbs]) {
-                    // Already converted
-                    src = imgConversionCache[outputRoot][srcAbs];
-                } else {
-                    // Not converted yet
-                    var dest = '';
-
-                    // Replace extension
-                    dest = links.join(path.dirname(srcAbs), path.basename(srcAbs, ext)+'.png');
-                    dest = dest[0] == '/'? dest.slice(1) : dest;
-
-                    // Get a name that doesn't exists
-                    dest = fs.getUniqueFilename(outputRoot, dest);
-
-                    options.book.log.debug.ln('detect invalid image (will be converted to png):', srcAbs);
-
-                    // Add to cache
-                    imgConversionCache[outputRoot][srcAbs] = '/'+dest;
-
-                    // Push to convert
-                    toConvert.push({
-                        origin: origin,
-                        content: svgContent[srcAbs],
-                        source: isExternal? srcAbs : path.join('./', srcAbs),
-                        dest: path.join('./', dest)
-                    });
-
-                    src = links.join('/', dest);
-                }
-
-                // Reset as relative to output
-                src = links.toAbsolute(src, options.base, options.output);
-            }
-
-            else if (origin) {
-                // Need to downlaod image
-                toConvert.push({
-                    origin: origin,
-                    source: path.join('./', srcAbs)
-                });
-            }
-        }
-
-        $(this).attr('src', src);
-    });
-
-    // Normalize links
-    $('a').each(function() {
-        var href = $(this).attr('href');
-        if (!href) return;
-
-        if (links.isAnchor(href)) {
-            // Keep it as it is
-        } else if (links.isRelative(href)) {
-            var parts = url.parse(href);
-            var absolutePath = links.join(options.base, parts.pathname);
-            var anchor = parts.hash || '';
-
-
-            // If is in navigation relative: transform as content
-            if (options.navigation[absolutePath]) {
-                absolutePath = options.book.contentLink(absolutePath);
-            }
-
-            // If md/adoc/rst files is not in summary
-            // or for ebook, signal all files that are outside the summary
-            else if (_.contains(parsableExtensions, path.extname(absolutePath)) ||
-            _.contains(['epub', 'pdf', 'mobi'], options.book.options.generator)) {
-                options.book.log.warn.ln('page', options.input, 'contains an hyperlink to resource outside spine \''+href+'\'');
-            }
-
-            // Transform as absolute
-            href = links.toAbsolute('/'+absolutePath, options.base, options.output)+anchor;
-        } else {
-            // External links
-            $(this).attr('target', '_blank');
-        }
-
-        // Transform extension
-        $(this).attr('href', href);
-    });
-
-    // Highlight code blocks
-    $('code').each(function() {
-        // Normalize language
-        var lang = _.chain(
-                ($(this).attr('class') || '').split(' ')
-            )
-            .map(function(cl) {
-                // Markdown
-                if (cl.search('lang-') === 0) return cl.slice('lang-'.length);
-
-                // Asciidoc
-                if (cl.search('language-') === 0) return cl.slice('language-'.length);
-
-                return null;
-            })
-            .compact()
-            .first()
-            .value();
-
-        var source = $(this).text();
-        var blk = options.book.template.applyBlock('code', {
-            body: source,
-            kwargs: {
-                language: lang
-            }
-        });
-
-        if (blk.html === false) $(this).text(blk.body);
-        else $(this).html(blk.body);
-    });
-
-    // Replace glossary terms
-    var glossary = _.sortBy(options.glossary, function(term) {
-        return -term.name.length;
-    });
-
-    _.each(glossary, function(term) {
-        var r =  new RegExp( '\\b(' + pregQuote(term.name.toLowerCase()) + ')\\b' , 'gi' );
-        var includedInFiles = false;
-
-        $('*').each(function() {
-            // Ignore codeblocks
-            if (_.contains(['code', 'pre', 'a'], this.name.toLowerCase())) return;
-
-            replaceText($, this, r, function(match) {
-                // Add to files index in glossary
-                if (!includedInFiles) {
-                    includedInFiles = true;
-                    term.files = term.files || [];
-                    term.files.push(options.navigation[options.input]);
-                }
-                return '<a href=\''+links.toAbsolute('/GLOSSARY.html', options.base, options.output) + '#' + term.id+'\' class=\'glossary-term\' title=\''+_.escape(term.description)+'\'>'+match+'</a>';
-            });
-        });
-    });
-
-    return {
-        html: renderDom($),
-        images: toConvert
-    };
-}
-
-// Convert svg images to png
-function convertImages(images, options) {
-    if (!options.convertImages) return Q();
-
-    var downloaded = [];
-    options.book.log.debug.ln('convert ', images.length, 'images to png');
-
-    return batch.execEach(images, {
-        max: 100,
-        fn: function(image) {
-            var imgin = path.resolve(options.book.options.output, image.source);
-
-            return Q()
-
-            // Write image if need to be download
-            .then(function() {
-                if (!image.origin && !_.contains(downloaded, image.origin)) return;
-                options.book.log.debug('download image', image.origin, '...');
-                downloaded.push(image.origin);
-                return options.book.log.debug.promise(fs.writeStream(imgin, request(image.origin)))
-                .fail(function(err) {
-                    if (!_.isError(err)) err = new Error(err);
-
-                    err.message = 'Fail downloading '+image.origin+': '+err.message;
-                    throw err;
-                });
-            })
-
-            // Write svg if content
-            .then(function() {
-                if (!image.content) return;
-                return fs.writeFile(imgin, image.content);
-            })
-
-            // Convert
-            .then(function() {
-                if (!image.dest) return;
-                var imgout = path.resolve(options.book.options.output, image.dest);
-                options.book.log.debug('convert image', image.source, 'to', image.dest, '...');
-                return options.book.log.debug.promise(imgUtils.convertSVG(imgin, imgout));
-            });
-        }
-    })
-    .then(function() {
-        options.book.log.debug.ok(images.length+' images converted with success');
-    });
-}
-
-// Adapt page content to be relative to a base folder
-function normalizePage(sections, options) {
-    options = _.defaults(options || {}, {
-        // Current book
-        book: null,
-
-        // Do we need to convert svg?
-        convertImages: false,
-
-        // Current file path
-        input: '.',
-
-        // Navigation to use to transform path
-        navigation: {},
-
-        // Directory parent of the file currently in rendering process
-        base: './',
-
-        // Directory parent from the html output
-        output: './',
-
-        // Glossary terms
-        glossary: []
-    });
-
-    // List of images to convert
-    var toConvert = [];
-
-    sections = _.map(sections, function(section) {
-        if (section.type != 'normal') return section;
-
-        var out = normalizeHtml(section.content, options);
-
-        toConvert = toConvert.concat(out.images);
-        section.content = out.html;
-        return section;
-    });
-
-    return Q()
-    .then(function() {
-        toConvert = _.uniq(toConvert, 'source');
-        return convertImages(toConvert, options);
-    })
-    .thenResolve(sections);
-}
-
-
-module.exports = {
-    normalize: normalizePage
-};

lib/utils/path.js

@@ -1,40 +0,0 @@
-var _ = require("lodash");
-var path = require("path");
-
-// Return true if file path is inside a folder
-function isInRoot(root, filename) {
-    filename = path.normalize(filename);
-    return (filename.substr(0, root.length) === root);
-}
-
-// Resolve paths in a specific folder
-// Throw error if file is outside this folder
-function resolveInRoot(root) {
-    var input, result, err;
-
-    input = _.chain(arguments)
-        .toArray()
-        .slice(1)
-        .reduce(function(current, p) {
-            // Handle path relative to book root ("/README.md")
-            if (p[0] == "/" || p[0] == "\\") return p.slice(1);
-
-            return current? path.join(current, p) : path.normalize(p);
-        }, "")
-        .value();
-
-    result = path.resolve(root, input);
-
-    if (!isInRoot(root, result)) {
-        err = new Error("EACCESS: \"" + result + "\" not in \"" + root + "\"");
-        err.code = "EACCESS";
-        throw err;
-    }
-
-    return result;
-}
-
-module.exports = {
-    isInRoot: isInRoot,
-    resolveInRoot: resolveInRoot
-};

lib/utils/progress.js

@@ -1,55 +0,0 @@
-var _ = require('lodash');
-
-// Returns from a navigation and a current file, a snapshot of current detailed state
-function calculProgress(navigation, current) {
-    var n = _.size(navigation);
-    var percent = 0, prevPercent = 0, currentChapter = null;
-    var done = true;
-
-    var chapters = _.chain(navigation)
-
-    // Transform as array
-    .map(function(nav, path) {
-        nav.path = path;
-        return nav;
-    })
-
-    // Sort entries
-    .sortBy(function(nav) {
-        return nav.index;
-    })
-
-    .map(function(nav, i) {
-        // Calcul percent
-        nav.percent = (i * 100) / Math.max((n - 1), 1);
-
-        // Is it done
-        nav.done = done;
-        if (nav.path == current) {
-            currentChapter = nav;
-            percent = nav.percent;
-            done = false;
-        } else if (done) {
-            prevPercent = nav.percent;
-        }
-
-        return nav;
-    })
-    .value();
-
-    return {
-        // Previous percent
-        prevPercent: prevPercent,
-
-        // Current percent
-        percent: percent,
-
-        // List of chapter with progress
-        chapters: chapters,
-
-        // Current chapter
-        current: currentChapter
-    };
-}
-
-module.exports = calculProgress;

lib/utils/server.js

@@ -1,94 +0,0 @@
-var Q = require("q");
-var events = require("events");
-var http = require("http");
-var send = require("send");
-var util = require("util");
-var url = require("url");
-
-var Server = function() {
-    this.running = null;
-    this.dir = null;
-    this.port = 0;
-    this.sockets = [];
-};
-util.inherits(Server, events.EventEmitter);
-
-// Return true if the server is running
-Server.prototype.isRunning = function() {
-    return !!this.running;
-};
-
-// Stop the server
-Server.prototype.stop = function() {
-    var that = this;
-    if (!this.isRunning()) return Q();
-
-    var d = Q.defer();
-    this.running.close(function(err) {
-        that.running = null;
-        that.emit("state", false);
-
-        if (err) d.reject(err);
-        else d.resolve();
-    });
-
-    for (var i = 0; i < this.sockets.length; i++) {
-        this.sockets[i].destroy();
-    }
-
-    return d.promise;
-};
-
-Server.prototype.start = function(dir, port) {
-    var that = this, pre = Q();
-    port = port || 8004;
-
-    if (that.isRunning()) pre = this.stop();
-    return pre
-    .then(function() {
-        var d = Q.defer();
-
-        that.running = http.createServer(function(req, res){
-            // Render error
-            function error(err) {
-                res.statusCode = err.status || 500;
-                res.end(err.message);
-            }
-
-            // Redirect to directory"s index.html
-            function redirect() {
-                res.statusCode = 301;
-                res.setHeader("Location", req.url + "/");
-                res.end("Redirecting to " + req.url + "/");
-            }
-
-            // Send file
-            send(req, url.parse(req.url).pathname)
-            .root(dir)
-            .on("error", error)
-            .on("directory", redirect)
-            .pipe(res);
-        });
-
-        that.running.on("connection", function (socket) {
-            that.sockets.push(socket);
-            socket.setTimeout(4000);
-            socket.on("close", function () {
-                that.sockets.splice(that.sockets.indexOf(socket), 1);
-            });
-        });
-
-        that.running.listen(port, function(err) {
-            if (err) return d.reject(err);
-
-            that.port = port;
-            that.dir = dir;
-            that.emit("state", true);
-            d.resolve();
-        });
-
-        return d.promise;
-    });
-};
-
-module.exports = Server;

lib/utils/string.js

@@ -1,27 +0,0 @@
-var _ = require("lodash");
-
-function escapeShellArg(arg) {
-    var ret = "";
-
-    ret = arg.replace(/"/g, '\\"');
-
-    return "\"" + ret + "\"";
-}
-
-function optionsToShellArgs(options) {
-    return _.chain(options)
-    .map(function(value, key) {
-        if (value === null || value === undefined || value === false) return null;
-        if (value === true) return key;
-        return key+"="+escapeShellArg(value);
-    })
-    .compact()
-    .value()
-    .join(" ");
-}
-
-module.exports = {
-    escapeShellArg: escapeShellArg,
-    optionsToShellArgs: optionsToShellArgs,
-    toLowerCase: String.prototype.toLowerCase.call.bind(String.prototype.toLowerCase)
-};

lib/utils/watch.js

@@ -1,40 +0,0 @@
-var Q = require("q");
-var _ = require("lodash");
-var path = require("path");
-var chokidar = require("chokidar");
-
-var parsers = require("gitbook-parsers");
-
-function watch(dir) {
-    var d = Q.defer();
-    dir = path.resolve(dir);
-
-    var toWatch = [
-        "book.json", "book.js"
-    ];
-
-    _.each(parsers.extensions, function(ext) {
-        toWatch.push("**/*"+ext);
-    });
-
-    var watcher = chokidar.watch(toWatch, {
-        cwd: dir,
-        ignored: "_book/**",
-        ignoreInitial: true
-    });
-
-    watcher.once("all", function(e, filepath) {
-        watcher.close();
-
-        d.resolve(filepath);
-    });
-    watcher.once("error", function(err) {
-        watcher.close();
-
-        d.reject(err);
-    });
-
-    return d.promise;
-}
-
-module.exports = watch;

lib/version.js

@@ -1,19 +0,0 @@
-var semver = require('semver');
-var pkg = require('../package.json');
-
-var VERSION = pkg.version;
-var VERSION_STABLE = VERSION.replace(/\-(\S+)/g, '');
-
-// Test if current current gitbook version satisfies a condition
-// We can't directly use samver.satisfies since it will break all plugins when gitbook version is a prerelease (beta, alpha)
-function satisfies(condition) {
-    // Test with real version
-    if (semver.satisfies(VERSION, condition)) return true;
-
-    // Test with future stable release
-    return semver.satisfies(VERSION_STABLE, condition);
-}
-
-module.exports = {
-    satisfies: satisfies
-};

package.json

@@ -1,93 +1,41 @@
 {
     "name": "gitbook",
-    "version": "2.6.4",
-    "homepage": "https://www.gitbook.com",
-    "description": "Library and cmd utility to generate GitBooks",
-    "main": "lib/index.js",
-    "dependencies": {
-        "q": "1.0.1",
-        "lodash": "3.10.1",
-        "graceful-fs": "3.0.5",
-        "resolve": "0.6.3",
-        "fs-extra": "0.16.5",
-        "fstream-ignore": "1.0.2",
-        "gitbook-parsers": "0.8.9",
-        "gitbook-plugin-highlight": "1.0.3",
-        "gitbook-plugin-sharing": "1.0.1",
-        "gitbook-plugin-search": "1.1.0",
-        "gitbook-plugin-fontsettings": "1.0.2",
-        "nunjucks": "2.2.0",
-        "nunjucks-autoescape": "1.0.0",
-        "nunjucks-filter": "1.0.0",
-        "i18n": "0.5.0",
-        "semver": "5.0.1",
-        "npmi": "0.1.1",
-        "cheerio": "0.19.0",
-        "gitbook-plugin-livereload": "0.0.1",
-        "chokidar": "~1.0.5",
-        "send": "0.2.0",
-        "tiny-lr": "0.2.1",
-        "tmp": "0.0.24",
-        "crc": "3.2.1",
-        "bash-color": "0.0.3",
-        "urijs": "1.17.0",
-        "request": "2.51.0",
-        "npm": "2.4.1",
-        "dom-serializer": "0.1.0",
-        "spawn-cmd": "0.0.2",
-        "escape-string-regexp": "1.0.3",
-        "juice": "1.5.0",
-        "jsonschema": "1.0.2",
-        "json-schema-defaults": "0.1.1",
-        "merge-defaults": "0.2.1",
-        "github-slugid": "1.0.0"
-    },
+    "version": "0.1.0",
     "devDependencies": {
-        "eslint": "1.5.0",
-        "mocha": "2.3.2",
-        "should": "7.1.0",
-        "should-promised": "0.3.1",
-        "gulp": "^3.8.11",
-        "gulp-rename": "^1.2.2",
-        "gulp-uglify": "1.1.0",
-        "gulp-less": "3.0.2",
-        "gulp-minify-css": "1.0.0",
-        "gulp-util": "3.0.6",
-        "browserify": "11.0.1",
-        "merge-stream": "0.1.7",
-        "vinyl-source-stream": "1.1.0",
-        "jquery": "2.1.4",
-        "mousetrap": "1.5.3",
-        "font-awesome": "4.1.0"
+        "@biomejs/biome": "^1.9.4",
+        "@changesets/cli": "^2.27.12",
+        "turbo": "^2.4.4",
+        "vercel": "^39.3.0"
     },
+    "packageManager": "bun@1.2.4",
+    "overrides": {
+        "@codemirror/state": "6.4.1",
+        "react": "18.3.1",
+        "react-dom": "18.3.1"
+    },
+    "private": true,
     "scripts": {
-        "test": "node_modules/.bin/mocha --reporter spec --timeout 15000"
+        "dev": "turbo run dev",
+        "dev:v2": "turbo run dev:v2",
+        "build": "turbo run build",
+        "build:v2": "turbo run build:v2",
+        "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
+        "typecheck": "turbo run typecheck",
+        "format": "biome check --write ./",
+        "format:check": "biome check --diagnostic-level=error ./",
+        "unit": "turbo run unit",
+        "e2e": "turbo run e2e",
+        "e2e-customers": "turbo run e2e-customers",
+        "changeset": "changeset",
+        "changeset-version": "changeset version && bun run format",
+        "release": "turbo run release && changeset publish",
+        "release:preview": "turbo run release:preview",
+        "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
+        "clean": "turbo run clean"
     },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/GitbookIO/gitbook.git"
-    },
-    "bin": {
-        "gitbook": "./bin/gitbook.js"
-    },
-    "keywords": [
-        "git",
-        "book",
-        "gitbook"
-    ],
-    "author": "FriendCode Inc. <contact@gitbook.com>",
-    "license": "Apache-2.0",
-    "bugs": {
-        "url": "https://github.com/GitbookIO/gitbook/issues"
-    },
-    "contributors": [
-        {
-            "name": "Aaron O'Mullan",
-            "email": "aaron@gitbook.com"
-        },
-        {
-            "name": "Samy Pessé",
-            "email": "samy@gitbook.com"
-        }
-    ]
+    "workspaces": ["packages/*"],
+    "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"
+    }
 }

packages/cache-do/.gitignore

@@ -0,0 +1,3 @@
+.wrangler
+worker-configuration.d.ts
+dist/

packages/cache-do/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @gitbook/cache-do
+
+## 0.1.1
+
+### Patch Changes
+
+-   b7a5106: Disable cloudflare observability in production
+
+## 0.1.0
+
+### Minor Changes
+
+-   9b8d519: Experiment with optimizing billable duration in Cloudflare by using multiple RPC sessions instead of one
+-   636b868: First version of a new cache backend powered by Cloudflare Durable Objects
+
+### Patch Changes
+
+-   56f5fa1: Enable Workers observability with a sampling of 0.1

packages/cache-do/README.md

@@ -0,0 +1,22 @@
+# `@gitbook/cache-do`
+
+Cache backend, powered by Cloudflare Durable Objects. The cache is optimized for GitBook use-cases.
+
+### Performances
+
+The cache backend is optimized for performances by being distributed and accessible close to the worker locations that are reading it.
+
+### Geo-distribution
+
+To achieve a good balance between **performances** and **consistency**, cache objects are distributed over 7 locations, representing continents.
+
+It makes it possible to purge all 7 locations in one go and achieve fast consistency.
+
+### Concepts
+
+**Cache tag**: unique tag in the cache environment. A cache tag groups multiple keys that should be purged together in one operation.
+Cache tags should not contain a large set of unique keys. Exceeding thousands could lead to performances or reliability issues.
+
+**Cache key**: unique key in the cache environment. Each key should be assigned to a `tag`.
+
+**Location**: cache is distributed over 7 unique locations, one for each continent.

packages/cache-do/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@gitbook/cache-do",
+    "type": "module",
+    "private": true,
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        },
+        "./api": {
+            "types": "./dist/api.d.ts",
+            "development": "./src/api.ts",
+            "default": "./dist/api.js"
+        }
+    },
+    "version": "0.1.1",
+    "dependencies": {
+        "@msgpack/msgpack": "^3.0.0-beta2",
+        "lru_map": "^0.4.1"
+    },
+    "devDependencies": {
+        "typescript": "^5.5.3",
+        "wrangler": "^3.109.2"
+    },
+    "scripts": {
+        "generate": "wrangler types --experimental-include-runtime",
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w",
+        "release": "wrangler deploy",
+        "release:preview": "wrangler deploy && wrangler deploy --env preview"
+    },
+    "files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
+}

packages/cache-do/src/CacheObject.ts

@@ -0,0 +1,292 @@
+import { DurableObject } from 'cloudflare:workers';
+import { decode, encode } from '@msgpack/msgpack';
+import { LRUMap } from 'lru_map';
+
+export interface CacheObjectDescriptor {
+    get: <Value = unknown>(key: string) => Promise<Value | undefined>;
+    set: <Value = unknown>(key: string, value: Value, expiresAt: number) => Promise<void>;
+}
+
+/**
+ * Value stored in a chunked binary msgpack format.
+ * Stored under the key `prop.${key}.${index}`.
+ */
+interface CacheObjectProp<Value = unknown> {
+    value: Value;
+    expiresAt: number;
+}
+
+/**
+ * Expiration clock stored under the key `exp.${expiresAt}.${key}`.
+ */
+interface CacheObjectExp {
+    /** Key of the property */
+    k: string;
+    /** Number of chunks */
+    c: number;
+}
+
+/**
+ * Durable Object class being deployed as a distributed cache.
+ */
+export class CacheObject extends DurableObject {
+    private lru = new LRUMap<string, { match: CacheObjectProp | undefined }>(500);
+
+    /**
+     * Open a descriptor to access the cache object.
+     * The goal is to minimize the amount of RPC sessions between the client and the cache object.
+     * One session is opened per request on the client side and used to perform multiple operations.
+     * https://developers.cloudflare.com/workers/runtime-apis/rpc/#return-functions-from-rpc-methods
+     */
+    public open(): CacheObjectDescriptor {
+        return {
+            get: async <Value = unknown>(key: string) => {
+                return this.get<Value>(key);
+            },
+            set: async <Value = unknown>(key: string, value: Value, expiresAt: number) => {
+                await this.set(key, value, expiresAt);
+            },
+        };
+    }
+
+    /**
+     * Get the value of a property.
+     */
+    public async get<Value = unknown>(key: string) {
+        return this.logOperation({ operation: 'get', key }, async (setLog) => {
+            // Try the memory state first.
+            const memoryEntry = this.lru.get(key);
+            if (memoryEntry) {
+                setLog({ memory: true });
+                setLog({ memoryMatch: !!memoryEntry.match });
+                if (!memoryEntry.match) {
+                    return;
+                }
+
+                const isExpired = memoryEntry.match.expiresAt < Date.now();
+                setLog({ memoryExpired: isExpired });
+
+                if (!isExpired) {
+                    return memoryEntry.match.value as Value;
+                }
+            }
+
+            return await this.getFromStorage<Value>(key);
+        });
+    }
+
+    /**
+     * Get the value of a property from the DO storage.
+     */
+    public async getFromStorage<Value = unknown>(key: string) {
+        return this.logOperation({ operation: 'getFromStorage', key }, async (setLog) => {
+            const entries = await this.ctx.storage.list<Uint8Array>({
+                prefix: getStoragePropKey(key),
+                noCache: true,
+            });
+            if (entries.size) {
+                const entry = decodeChunks<CacheObjectProp<Value>>(entries);
+                setLog({ chunks: entries.size, chunksSize: entry?.size ?? 0 });
+                if (entry && entry.value.expiresAt > Date.now()) {
+                    // Found
+                    this.lru.set(key, { match: entry.value });
+                    return entry.value.value;
+                }
+            }
+
+            // Not found
+            this.lru.set(key, { match: undefined });
+        });
+    }
+
+    /**
+     * Set a value in the cache object.
+     */
+    public async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
+        return this.logOperation({ operation: 'set', key }, async (setLog) => {
+            const prop: CacheObjectProp<Value> = {
+                value,
+                expiresAt,
+            };
+
+            this.lru.set(key, { match: prop });
+            await this.ctx.storage.transaction(async (tx) => {
+                const entries = encodeChunks(key, prop);
+                const chunks = Object.keys(entries).length;
+                setLog({ chunks });
+
+                const clockValue: CacheObjectExp = {
+                    k: key,
+                    c: chunks,
+                };
+
+                await tx.put(getGCClockKey(key, expiresAt), clockValue);
+                await tx.put(entries);
+
+                const currentAlarm = await tx.getAlarm();
+                if (!currentAlarm) {
+                    // Set an alarm to garbage collect all entries that have expired in 12h.
+                    await tx.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
+                }
+            });
+        });
+    }
+
+    /**
+     * Purge all keys in the cache object.
+     */
+    public async purge() {
+        return this.logOperation({ operation: 'purge' }, async (setLog) => {
+            const result = new Set<string>();
+
+            try {
+                // List all the keys in the cache object.
+                const entries = await this.ctx.storage.list<CacheObjectExp>({
+                    prefix: 'exp.',
+                    noCache: true,
+                });
+                setLog({ entries: entries.size });
+                entries.forEach((exp) => {
+                    result.add(exp.k);
+                });
+            } catch (_error) {}
+
+            await this.reset();
+            return Array.from(result);
+        });
+    }
+
+    /**
+     * Alarm to garbage collect all entries that have expired.
+     */
+    async alarm() {
+        return this.logOperation({ operation: 'alarm' }, async (setLog) => {
+            try {
+                const entries = await this.ctx.storage.list<CacheObjectExp>({
+                    prefix: 'exp.',
+                    noCache: true,
+                });
+                setLog({ entries: entries.size });
+                const toDeleteSet = new Set<string>();
+
+                for (const [key, exp] of entries) {
+                    const timestamp = Number.parseInt(key.split('.')[1]);
+                    if (timestamp < Date.now()) {
+                        toDeleteSet.add(key);
+                        for (let i = 0; i < exp.c; i++) {
+                            toDeleteSet.add(getStoragePropChunkKey(exp.k, i));
+                        }
+                    }
+                }
+
+                // Delete the keys by batch of 128.
+                const toDelete = Array.from(toDeleteSet);
+                setLog({ toDelete: toDelete.length });
+                for (let i = 0; i < toDelete.length; i += 128) {
+                    await this.ctx.storage.delete(toDelete.slice(i, i + 128));
+                }
+
+                // If there are still keys to delete, set an alarm to continue the deletion in 12h.
+                if (toDelete.length) {
+                    await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
+                }
+            } catch (_error) {
+                await this.reset();
+            }
+        });
+    }
+
+    /**
+     * Reset the cache object.
+     */
+    async reset() {
+        return this.logOperation({ operation: 'reset' }, async () => {
+            this.lru.clear();
+            await this.ctx.storage.deleteAll();
+        });
+    }
+
+    /**
+     * Time and log an operation.
+     */
+    async logOperation<T>(
+        log: Record<string, unknown>,
+        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
+    ): Promise<T> {
+        const objectId = this.ctx.id.name ?? this.ctx.id.toString();
+        const update: Record<string, unknown> = {};
+        const start = performance.now();
+        try {
+            return await fn((arg) => {
+                Object.assign(update, arg);
+            });
+        } finally {
+            const duration = performance.now() - start;
+            console.log({ ...log, ...update, objectId, duration });
+        }
+    }
+}
+
+function getStoragePropKey(key: string): string {
+    return `prop.${key}.`;
+}
+
+function getStoragePropChunkKey(key: string, index: number): string {
+    return `${getStoragePropKey(key)}${index}`;
+}
+
+function getGCClockRootKey(timestamp: number): string {
+    return `exp.${timestamp}.`;
+}
+
+function getGCClockKey(key: string, expiresAt: number): string {
+    return `${getGCClockRootKey(expiresAt)}${key}`;
+}
+
+function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
+    const buf = encode(value);
+    const entries: Record<string, Uint8Array> = {};
+    const chunks = chunkUint8Array(buf, 128 * 1024);
+
+    for (let index = 0; index < chunks.length; index++) {
+        entries[getStoragePropChunkKey(key, index)] = chunks[index];
+    }
+
+    return entries;
+}
+
+function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
+    const chunks = Array.from(entries.entries())
+        .map(([key, value]) => {
+            const index = Number.parseInt(key.split('.').pop()!);
+            return [index, value] as const;
+        })
+        .sort(([a], [b]) => a - b)
+        .map(([, value]) => value);
+
+    if (chunks.length === 0) {
+        return;
+    }
+
+    const buf = mergeUint8Array(chunks);
+    return { value: decode(buf) as T, size: buf.length };
+}
+
+function chunkUint8Array(input: Uint8Array, chunkSize: number): Uint8Array[] {
+    const chunks: Uint8Array[] = [];
+    for (let i = 0; i < input.length; i += chunkSize) {
+        chunks.push(input.slice(i, i + chunkSize));
+    }
+    return chunks;
+}
+
+function mergeUint8Array(chunks: Uint8Array[]): Uint8Array {
+    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+        result.set(chunk, offset);
+        offset += chunk.length;
+    }
+    return result;
+}

packages/cache-do/src/CacheObjectStub.ts

@@ -0,0 +1,97 @@
+import type { CacheObject } from './CacheObject';
+
+export type CacheLocationId = ContinentCode;
+const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
+
+/**
+ * Location hint for the CacheObject durable object.
+ */
+const doLocationHints: {
+    [key in CacheLocationId]: DurableObjectLocationHint;
+} = {
+    AF: 'afr',
+    AS: 'apac',
+    NA: 'wnam',
+    SA: 'sam',
+    AN: 'oc',
+    EU: 'weur',
+    OC: 'oc',
+};
+
+/**
+ * Client to access a cache tag.
+ */
+export class CacheObjectStub {
+    private stub: DurableObjectStub<CacheObject>;
+
+    constructor(
+        /** Binding to the CacheObject durable object */
+        private doNamespace: DurableObjectNamespace<CacheObject>,
+        /** ID of the location to target */
+        private locationId: CacheLocationId,
+        /** Name of the tag */
+        private tag: string
+    ) {
+        const groupId = getCacheObjectIdName(this.locationId, this.tag);
+        this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
+            // Initialize the object with a locaiton hint,
+            // as we might want to purge all locations before the object is created.
+            // https://developers.cloudflare.com/durable-objects/reference/data-location/
+            locationHint: doLocationHints[this.locationId],
+        });
+    }
+
+    /**
+     * Open a descriptor to the cache object.
+     * It can be used to perform multiple operations in a single RPC session.
+     * Ex:
+     * ```ts
+     * using desc = cache.open();
+     * await desc.set('key', 'value', Date.now() + 1000);
+     * await desc.get('key');
+     * ```
+     */
+    async open() {
+        return await this.stub.open();
+    }
+
+    /**
+     * Get a value from the cache.
+     */
+    async get<Value = unknown>(key: string) {
+        return (await this.stub.get(key)) as Value | undefined;
+    }
+
+    /**
+     * Set a value in the cache.
+     */
+    async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
+        return await this.stub.set(key, value, expiresAt);
+    }
+
+    /**
+     * Purge all keys in the cache tag.
+     */
+    async purge() {
+        const keys = new Set<string>();
+        await Promise.all(
+            allLocations.map(async (locationId) => {
+                const groupId = getCacheObjectIdName(locationId, this.tag);
+                const cacheGroup = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
+                    // Initialize the object with a locaiton hint,
+                    // as we might want to purge all locations before the object is created.
+                    // https://developers.cloudflare.com/durable-objects/reference/data-location/
+                    locationHint: doLocationHints[this.locationId],
+                });
+                const locationkeys = await cacheGroup.purge();
+                locationkeys.forEach((key) => keys.add(key));
+            })
+        );
+
+        return keys;
+    }
+}
+
+function getCacheObjectIdName(locationId: CacheLocationId, tag: string): string {
+    return `${locationId}:${tag}`;
+}

packages/cache-do/src/api.ts

@@ -0,0 +1 @@
+export * from './CacheObjectStub';

packages/cache-do/src/index.ts

@@ -0,0 +1,9 @@
+import { WorkerEntrypoint } from 'cloudflare:workers';
+
+export * from './CacheObject';
+
+export default class Worker extends WorkerEntrypoint {
+    fetch() {
+        return new Response('Hello, world!');
+    }
+}

packages/cache-do/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "noEmit": false,
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "incremental": true,
+        "types": ["./.wrangler/types/runtime.d.ts"]
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules"]
+}

packages/cache-do/wrangler.toml

@@ -0,0 +1,27 @@
+main = "./src/index.ts"
+name = "gitbook-open-cache"
+compatibility_date = "2024-09-02"
+
+durable_objects.bindings = [
+  {name = "CACHE", class_name = "CacheObject"}
+]
+
+migrations = [
+  {tag = "v1", new_classes = ["CacheObject"]}
+]
+
+[observability]
+enabled = false
+
+[env.preview]
+name = "gitbook-open-cache-preview"
+durable_objects.bindings = [
+  {name = "CACHE", class_name = "CacheObject"}
+]
+migrations = [
+  {tag = "v1", new_classes = ["CacheObject"]}
+]
+
+[env.preview.observability]
+enabled = true
+head_sampling_rate = 0.1

packages/cache-tags/.gitignore

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

packages/cache-tags/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @gitbook/cache-tags
+
+## 0.1.0
+
+### Minor Changes
+
+-   05ffd0e: Initial version of the package

packages/cache-tags/README.md

@@ -0,0 +1,3 @@
+# `@gitbook/cache-tags`
+
+Utility to generate cache tags for GitBook Open.

packages/cache-tags/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@gitbook/cache-tags",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "version": "0.1.0",
+    "dependencies": {
+        "@gitbook/api": "0.96.1",
+        "assert-never": "^1.2.1"
+    },
+    "devDependencies": {
+        "typescript": "^5.5.3"
+    },
+    "scripts": {
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w"
+    },
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+}

packages/cache-tags/src/index.ts

@@ -0,0 +1,175 @@
+import type { ComputedContentSource } from '@gitbook/api';
+import assertNever from 'assert-never';
+
+/**
+ * Get a stringified cache tag for a given object.
+ */
+export function getCacheTag(
+    spec: /**
+     * All data related to a user
+     * @deprecated - in v2, no tag as this is an immutable data
+     */
+        | {
+              tag: 'user';
+              user: string;
+          }
+        /**
+         * All data related to a space
+         */
+        | {
+              tag: 'space';
+              space: string;
+          }
+        /**
+         * All data related to an integration.
+         */
+        | {
+              tag: 'integration';
+              integration: string;
+          }
+        /**
+         * All data related to a change request
+         */
+        | {
+              tag: 'change-request';
+              space: string;
+              changeRequest: string;
+          }
+        /**
+         * Immutable data related to a revision
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'revision';
+              space: string;
+              revision: string;
+          }
+        /**
+         * Immutable data related to a document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'document';
+              space: string;
+              document: string;
+          }
+        /**
+         * Immutable data related to a computed document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'computed-document';
+              space: string;
+              integration: string;
+          }
+        /**
+         * All data related to the URL of a content
+         */
+        | {
+              tag: 'url';
+              hostname: string;
+          }
+        /**
+         * All data related to a site
+         */
+        | {
+              tag: 'site';
+              site: string;
+          }
+        /**
+         * All data related to an OpenAPI spec
+         */
+        | {
+              tag: 'openapi';
+              organization: string;
+              openAPISpec: string;
+          }
+): string {
+    switch (spec.tag) {
+        case 'user':
+            return `user:${spec.user}`;
+        case 'url':
+            return `url:${spec.hostname}`;
+        case 'space':
+            return `space:${spec.space}`;
+        case 'change-request':
+            return `space:${spec.space}:change-request:${spec.changeRequest}`;
+        case 'revision':
+            return `space:${spec.space}:revision:${spec.revision}`;
+        case 'document':
+            return `space:${spec.space}:document:${spec.document}`;
+        case 'computed-document':
+            return `space:${spec.space}:computed-document:${spec.integration}`;
+        case 'site':
+            return `site:${spec.site}`;
+        case 'integration':
+            return `integration:${spec.integration}`;
+        case 'openapi':
+            return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
+        default:
+            assertNever(spec);
+    }
+}
+
+/**
+ * Get the tags for a computed content source.
+ */
+export function getComputedContentSourceCacheTags(
+    inContext: {
+        spaceId: string;
+        organizationId: string;
+    },
+    source: ComputedContentSource
+) {
+    const tags: string[] = [];
+
+    // We add the dependencies as tags, to ensure that the computed content is invalidated
+    // when the dependencies are updated.
+    const dependencies = Object.values(source.dependencies ?? {});
+    if (dependencies.length > 0) {
+        dependencies.forEach((dependency) => {
+            switch (dependency.ref.kind) {
+                case 'space':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'space',
+                            space: dependency.ref.space,
+                        })
+                    );
+                    break;
+                case 'openapi':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'openapi',
+                            organization: inContext.organizationId,
+                            openAPISpec: dependency.ref.spec,
+                        })
+                    );
+                    break;
+                default:
+                    // Do not throw for unknown dependency types
+                    // as it might mean we are lacking behind the API version
+                    break;
+            }
+        });
+    } else {
+        // Push a dummy tag, as the v1 is only using the first tag
+        tags.push(
+            getCacheTag({
+                tag: 'computed-document',
+                space: inContext.spaceId,
+                integration: source.integration,
+            })
+        );
+    }
+
+    // We invalidate the computed content when a new version of the integration is deployed.
+    tags.push(
+        getCacheTag({
+            tag: 'integration',
+            integration: source.integration,
+        })
+    );
+
+    return tags;
+}

packages/cache-tags/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "noEmit": false,
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "jsx": "react-jsx",
+        "incremental": true,
+        "types": [
+            "bun-types" // add Bun global
+        ]
+    },
+    "include": ["src/**/*.ts", "src/**/*.tsx"],
+    "exclude": ["node_modules"]
+}

packages/colors/.gitignore

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

packages/colors/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @gitbook/colors
+
+## 0.2.0
+
+### Minor Changes
+
+-   445baaa: Initial release

packages/colors/README.md

@@ -0,0 +1,3 @@
+# `@gitbook/colors`
+
+A set of default colors and transformation functions used throughout the GitBook Open and app.

packages/colors/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@gitbook/colors",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "version": "0.2.0",
+    "devDependencies": {
+        "typescript": "^5.5.3"
+    },
+    "scripts": {
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w"
+    },
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+}

packages/colors/src/colors.ts

@@ -0,0 +1,39 @@
+/**
+ * Default primary color throughout the GitBook ecosystem.
+ */
+export const DEFAULT_PRIMARY_COLOR = '#346DDB';
+
+/**
+ * The darkest color that exists in GitBook, used as the relative minimum of every generated color scale.
+ */
+export const DARK_BASE = '#1D1D1D';
+
+/**
+ * The lightest color that exists in GitBook, used as the relative maximum of every generated color scale.
+ */
+export const LIGHT_BASE = '#FFFFFF';
+
+/**
+ * Used as the basis of all UI elements that are not colored by the primary color. Neutral gray by default, overridden by site customization.
+ */
+export const DEFAULT_TINT_COLOR = '#787878';
+
+/**
+ * Used for informational messages and neutral alerts.
+ */
+export const DEFAULT_HINT_INFO_COLOR = '#787878';
+
+/**
+ * Used for showing important information or non-critical warnings.
+ */
+export const DEFAULT_HINT_WARNING_COLOR = '#FE9A00';
+
+/**
+ * Used for destructive actions or raising attention to critical information.
+ */
+export const DEFAULT_HINT_DANGER_COLOR = '#FB2C36';
+
+/**
+ * Used for showing positive actions or achievements.
+ */
+export const DEFAULT_HINT_SUCCESS_COLOR = '#00C950';

packages/colors/src/index.ts

@@ -0,0 +1,2 @@
+export * from './colors';
+export * from './transformations';

packages/colors/src/transformations.ts

@@ -0,0 +1,408 @@
+import { DARK_BASE, DEFAULT_TINT_COLOR, LIGHT_BASE } from './colors';
+
+type ColorShades = {
+    [key: string]: string;
+};
+
+type RGBColor = [number, number, number];
+type OKLABColor = { L: number; A: number; B: number };
+type OKLCHColor = { L: number; C: number; H: number };
+
+const D65 = [95.047, 100.0, 108.883]; // Reference white (D65)
+
+export enum ColorCategory {
+    backgrounds = 'backgrounds',
+    components = 'components',
+    borders = 'borders',
+    accents = 'accents',
+    text = 'text',
+}
+
+type ColorSubScale = {
+    [key: string]: number;
+};
+
+/**
+ * Main color scale object.
+ *
+ * Each `ColorCategory` can be in/excluded in Tailwind's utility classes generation.
+ * Each subitem maps a semantic name within that category to a step in the scale.
+ */
+export const scale: Record<ColorCategory, ColorSubScale> = {
+    [ColorCategory.backgrounds]: {
+        /** Base background */
+        base: 1,
+        /** Accent background */
+        subtle: 2,
+    },
+    [ColorCategory.components]: {
+        /** Component background */
+        DEFAULT: 3,
+        /** Component hover background */
+        hover: 4,
+        /** Component active background */
+        active: 5,
+    },
+    [ColorCategory.borders]: {
+        /** Subtle borders, separators */
+        subtle: 6,
+        /** Element border, focus rings */
+        DEFAULT: 7,
+        /** Element hover border */
+        hover: 8,
+    },
+    [ColorCategory.accents]: {
+        /** Solid backgrounds */
+        solid: 9,
+        /** Hovered solid backgrounds */
+        'solid-hover': 10,
+    },
+    [ColorCategory.text]: {
+        /** Very low-contrast text
+         * Caution: this contrast does not meet accessiblity guidelines.
+         * Always check if you need to include a mitigating contrast-more style for users who need it. */
+        subtle: 9,
+        /** Low-contrast text */
+        DEFAULT: 11,
+        /** High-contrast text */
+        strong: 12,
+    },
+};
+
+/**
+ * The mix of foreground and background for every step in a colour scale.
+ * 0: 100% of the background color's luminosity, white in light mode
+ * 1: 100% of the foreground color's luminosity, black in light mode
+ */
+export const colorMixMapping = {
+    // bgs          |components      |borders         |solid     |text
+    light: [0, 0.02, 0.03, 0.05, 0.07, 0.1, 0.15, 0.2, 0.5, 0.55, 0.6, 1],
+    dark: [0, 0.03, 0.08, 0.1, 0.13, 0.15, 0.2, 0.25, 0.5, 0.55, 0.75, 1],
+};
+
+/**
+ * Convert a hex color to an RGB color.
+ */
+export function hexToRgb(hex: string): string {
+    const [r, g, b] = hexToRgbArray(hex);
+    // Return the RGB values separated by spaces
+    return `${r} ${g} ${b}`;
+}
+
+/**
+ * Convert a hex color to a RGBA color.
+ */
+export function hexToRgba(hex: string, alpha: number): string {
+    const [r, g, b] = hexToRgbArray(hex);
+    // Return the RGBA values separated by spaces
+    return `rgba(${r}, ${g}, ${b}, ${alpha})`;
+}
+
+/**
+ * Generate Tailwind-compatible shades from a single color
+ * @param {string} hex The hex code to generate shades from
+ * @param {boolean} halfShades Generate additional shades, e.g. at 150
+ * @returns {{[key: number]: string}}
+ */
+export function shadesOfColor(hex: string, halfShades = false) {
+    const baseColor = hex;
+
+    const shades = [
+        50,
+        100,
+        200,
+        300,
+        400,
+        500,
+        600,
+        700,
+        800,
+        900,
+        ...(halfShades ? [150, 250, 350, 450, 550, 650, 750, 850] : []),
+    ].sort();
+
+    const result: ColorShades = {};
+
+    for (const shade of shades) {
+        const key = shade.toString();
+
+        if (shade === 500) {
+            result[key] = hex;
+            continue;
+        }
+
+        let shadeIndex = shade;
+        const isDarkShade = shadeIndex > 500;
+        if (isDarkShade) {
+            shadeIndex -= 500;
+        }
+
+        const percentage = shadeIndex / 500;
+        const startColor = isDarkShade ? DARK_BASE : baseColor;
+        const endColor = isDarkShade ? baseColor : LIGHT_BASE;
+
+        result[key] = getColor(percentage, hexToRgbArray(startColor), hexToRgbArray(endColor));
+    }
+
+    return result;
+}
+
+export type ColorScaleOptions = {
+    /** If set to `true`, inverts the scale (so 1 is black instead of white) and uses `colorMixMapping.dark` with different mix ratios per step. */
+    darkMode?: boolean;
+
+    /** Define a custom background color to use. If left undefined, the global `light`/`dark` values (in `colors.ts`) will be used. */
+    background?: string;
+
+    /** Define a custom foreground color to use. If left undefined, the global `light`/`dark` values (in `colors.ts`) will be used. */
+    foreground?: string;
+
+    mix?: {
+        /** If set to a hex code, this color will be additionally mixed into the generated scale according to `mix.ratio`. */
+        color: string;
+
+        /** Define a custom mix ratio to mix the `mix` color with. If left undefined, the default ratio will be used. */
+        ratio: number;
+    };
+};
+
+/**
+ * Generate a [Radix-like](https://www.radix-ui.com/colors/docs/palette-composition/understanding-the-scale) colour scale based of a hex colour.
+ * @param {string} hex The hex code to generate shades from
+ * @param {object} options
+ */
+export function colorScale(
+    hex: string,
+    {
+        darkMode = false,
+        background = darkMode ? DARK_BASE : LIGHT_BASE,
+        foreground = darkMode ? LIGHT_BASE : DARK_BASE,
+        mix,
+    }: ColorScaleOptions = {}
+) {
+    const baseColor = rgbToOklch(hexToRgbArray(hex));
+    const mixColor = mix?.color ? rgbToOklch(hexToRgbArray(mix.color)) : null;
+    const foregroundColor = rgbToOklch(hexToRgbArray(foreground));
+    const backgroundColor = rgbToOklch(hexToRgbArray(background));
+
+    if (mixColor && mix?.ratio && mix.ratio > 0) {
+        // If defined, we mix in a (tiny) bit of the mix color with the base color.
+        baseColor.L = mixColor.L * mix.ratio + baseColor.L * (1 - mix.ratio);
+        baseColor.C = mixColor.C * mix.ratio + baseColor.C * (1 - mix.ratio);
+        baseColor.H = mix.color === DEFAULT_TINT_COLOR ? baseColor.H : mixColor.H;
+    }
+
+    const mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
+
+    const result = [];
+
+    for (let index = 0; index < mapping.length; index++) {
+        const targetL =
+            foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
+
+        if (index === 8 && !mix && Math.abs(baseColor.L - targetL) < 0.2) {
+            // Original colour is close enough to target, so let's use the original colour as step 9.
+            result.push(hex);
+            continue;
+        }
+
+        const chromaRatio = index < 8 ? (index + 1) * 0.05 : 1;
+
+        const shade = {
+            L: targetL, // Blend lightness
+            C: baseColor.C * chromaRatio,
+            H: baseColor.H, // Maintain the hue from the base color
+        };
+
+        const newHex = rgbArrayToHex(oklchToRgb(shade));
+
+        result.push(newHex);
+    }
+
+    return result;
+}
+
+/**
+ * Convert a hex color to an RGB color set.
+ */
+export function hexToRgbArray(hex: string): RGBColor {
+    const originalHex = hex;
+
+    let value = hex.replace('#', '');
+    if (hex.length === 3) value = value + value;
+
+    const r = value.substring(0, 2);
+    const g = value.substring(2, 4);
+    const b = value.substring(4, 6);
+
+    const rgb = [r, g, b].map((channel) => {
+        try {
+            const channelInt = Number.parseInt(channel, 16);
+            if (channelInt < 0 || channelInt > 255) throw new Error();
+            return channelInt;
+        } catch {
+            throw new Error(`Invalid hex color provided: ${originalHex}`);
+        }
+    });
+
+    return rgb as RGBColor;
+}
+
+/**
+ * Convert a RGB color set to a hex color.
+ */
+export function rgbArrayToHex(rgb: RGBColor): string {
+    return `#${rgb
+        .map((channel) => {
+            const component = channel.toString(16);
+            if (component.length === 1) return `0${component}`;
+            return component;
+        })
+        .join('')}`;
+}
+
+export function getColor(percentage: number, start: RGBColor, end: RGBColor) {
+    const rgb = end.map((channel, index) => {
+        return Math.round(channel + percentage * (start[index] - channel));
+    });
+
+    return rgbArrayToHex(rgb as RGBColor);
+}
+
+// Utility constants and helper functions
+export function rgbToLinear(rgb: RGBColor): [number, number, number] {
+    return rgb.map((v) => {
+        const scaled = v / 255;
+        return scaled <= 0.04045 ? scaled / 12.92 : ((scaled + 0.055) / 1.055) ** 2.4;
+    }) as [number, number, number];
+}
+
+export function linearToRgb(linear: [number, number, number]): RGBColor {
+    return linear.map((v) => {
+        const scaled = v <= 0.0031308 ? 12.92 * v : 1.055 * v ** (1 / 2.4) - 0.055;
+        return Math.round(Math.max(0, Math.min(1, scaled)) * 255);
+    }) as RGBColor;
+}
+
+export function rgbToOklab(rgb: RGBColor): OKLABColor {
+    const [r, g, b] = rgbToLinear(rgb);
+
+    const l = 0.4122214708 * r + 0.5363325363 * g + 0.0514459929 * b;
+    const m = 0.2119034982 * r + 0.6806995451 * g + 0.1073969566 * b;
+    const s = 0.0883024619 * r + 0.2817188376 * g + 0.6299787005 * b;
+
+    const lRoot = Math.cbrt(l);
+    const mRoot = Math.cbrt(m);
+    const sRoot = Math.cbrt(s);
+
+    return {
+        L: 0.2104542553 * lRoot + 0.793617785 * mRoot - 0.0040720468 * sRoot,
+        A: 1.9779984951 * lRoot - 2.428592205 * mRoot + 0.4505937099 * sRoot,
+        B: 0.0259040371 * lRoot + 0.7827717662 * mRoot - 0.808675766 * sRoot,
+    };
+}
+
+export function oklabToRgb(oklab: OKLABColor): RGBColor {
+    const { L, A, B } = oklab;
+
+    const lRoot = L + 0.3963377774 * A + 0.2158037573 * B;
+    const mRoot = L - 0.1055613458 * A - 0.0638541728 * B;
+    const sRoot = L - 0.0894841775 * A - 1.291485548 * B;
+
+    const l = lRoot ** 3;
+    const m = mRoot ** 3;
+    const s = sRoot ** 3;
+
+    const r = 4.0767416621 * l - 3.3077115913 * m + 0.2309699292 * s;
+    const g = -1.2684380046 * l + 2.6097574011 * m - 0.3413193965 * s;
+    const b = -0.0041960863 * l - 0.7034186147 * m + 1.707614701 * s;
+
+    return linearToRgb([r, g, b]);
+}
+
+export function oklabToOklch(oklab: OKLABColor): OKLCHColor {
+    const { L, A, B } = oklab;
+    const C = Math.sqrt(A ** 2 + B ** 2);
+    const H = (Math.atan2(B, A) * 180) / Math.PI;
+    return { L, C, H: H < 0 ? H + 360 : H };
+}
+
+export function oklchToOklab(oklch: OKLCHColor): OKLABColor {
+    const { L, C, H } = oklch;
+    const rad = (H * Math.PI) / 180;
+    return {
+        L,
+        A: C * Math.cos(rad),
+        B: C * Math.sin(rad),
+    };
+}
+
+export function rgbToOklch(rgb: RGBColor): OKLCHColor {
+    return oklabToOklch(rgbToOklab(rgb));
+}
+
+export function oklchToRgb(oklch: OKLCHColor): RGBColor {
+    return oklabToRgb(oklchToOklab(oklch));
+}
+
+export function rgbToXyz(rgb: RGBColor): [number, number, number] {
+    const [r, g, b] = rgbToLinear(rgb);
+    return [
+        (r * 0.4124564 + g * 0.3575761 + b * 0.1804375) * 100,
+        (r * 0.2126729 + g * 0.7151522 + b * 0.072175) * 100,
+        (r * 0.0193339 + g * 0.119192 + b * 0.9503041) * 100,
+    ];
+}
+
+export function xyzToLab65(xyz: [number, number, number]): {
+    L: number;
+    A: number;
+    B: number;
+} {
+    const [x, y, z] = xyz.map((v, i) => {
+        const scaled = v / D65[i];
+        return scaled > 0.008856 ? Math.cbrt(scaled) : 7.787 * scaled + 16 / 116;
+    });
+
+    return {
+        L: 116 * y - 16,
+        A: 500 * (x - y),
+        B: 200 * (y - z),
+    };
+}
+
+export function rgbTolab65(rgb: RGBColor): { L: number; A: number; B: number } {
+    return xyzToLab65(rgbToXyz(rgb));
+}
+
+/*
+  Delta Phi Star perceptual lightness contrast by Andrew Somers:
+  https://github.com/Myndex/deltaphistar 
+*/
+export const PHI = 0.5 + Math.sqrt(1.25);
+
+export function dpsContrast(a: RGBColor, b: RGBColor) {
+    const dps = Math.abs(rgbTolab65(a).L ** PHI - rgbTolab65(b).L ** PHI);
+    const contrast = dps ** (1 / PHI) * Math.SQRT2 - 40;
+    return contrast < 7.5 ? 0 : contrast;
+}
+
+export function colorContrast(background: string, foreground: string[] = [LIGHT_BASE, DARK_BASE]) {
+    const bg = hexToRgbArray(background);
+
+    const best: { color?: RGBColor; contrast: number } = {
+        color: undefined,
+        contrast: 0,
+    };
+    for (const color of foreground) {
+        const c = hexToRgbArray(color);
+
+        const contrast = dpsContrast(c, bg);
+        if (contrast > best.contrast) {
+            best.color = c;
+            best.contrast = contrast;
+        }
+    }
+
+    return best.color ? rgbArrayToHex(best.color) : foreground[0];
+}

packages/colors/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "noEmit": false,
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "jsx": "react-jsx",
+        "incremental": true,
+        "types": [
+            "bun-types" // add Bun global
+        ]
+    },
+    "include": ["src/**/*.ts", "src/**/*.tsx"],
+    "exclude": ["node_modules"]
+}

packages/emoji-codepoints/.gitignore

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

packages/emoji-codepoints/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @gitbook/emoji-codepoints
+
+## 0.2.0
+
+### Minor Changes
+
+-   57adb3e: Second release to fix publishing with changeset
+
+## 0.1.0
+
+### Minor Changes
+
+-   5f8a8fe: Initial release

packages/emoji-codepoints/build.ts

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import emojisRaws from 'emoji-assets/emoji.json';
+
+interface EmojiData {
+    code_points: {
+        base: string;
+        fully_qualified: string;
+    };
+}
+
+const emojis = emojisRaws as Record<string, EmojiData>;
+const output: Record<string, string> = {};
+
+Object.entries(emojis).forEach(([key, value]) => {
+    const emoji = value.code_points?.fully_qualified;
+    if (emoji && key !== emoji) {
+        output[key] = emoji;
+    } else if (!emoji) {
+    }
+});
+
+fs.mkdirSync(path.resolve(__dirname, 'dist'), { recursive: true });
+fs.writeFileSync(
+    path.resolve(__dirname, 'dist/index.ts'),
+    `export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`
+);

packages/emoji-codepoints/package.json

@@ -0,0 +1,15 @@
+{
+    "name": "@gitbook/emoji-codepoints",
+    "description": "Optimized mapping of codepoints to the fully qualified emoji codepoints",
+    "version": "0.2.0",
+    "private": true,
+    "exports": "./dist/index.ts",
+    "dependencies": {},
+    "devDependencies": {
+        "emoji-assets": "^8.0.0"
+    },
+    "scripts": {
+        "generate": "bun ./build.ts",
+        "clean": "rm -rf ./dist"
+    }
+}

packages/gitbook-v2/.gitignore

@@ -0,0 +1,11 @@
+# next.js
+/.next/
+
+# vercel
+.vercel
+
+# cloudflare
+.open-next
+
+# Symbolic links
+public

packages/gitbook-v2/CHANGELOG.md

@@ -0,0 +1,21 @@
+# gitbook-v2
+
+## 0.1.2
+
+### Patch Changes
+
+-   05ffd0e: Improving data cache management for computed content
+-   Updated dependencies [05ffd0e]
+    -   @gitbook/cache-tags@0.1.0
+
+## 0.1.1
+
+### Patch Changes
+
+-   3e11678: fix: lost section groups
+
+## 0.1.0
+
+### Minor Changes
+
+-   cfccc44: Setup structure and deployment for new version

packages/gitbook-v2/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

packages/gitbook-v2/next.config.mjs

@@ -0,0 +1,36 @@
+// @ts-check
+
+/**
+ * @type {import('next').NextConfig}
+ */
+const nextConfig = {
+    experimental: {
+        useCache: true,
+    },
+
+    env: {
+        BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
+        GITBOOK_URL: process.env.GITBOOK_URL,
+        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
+        GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
+        GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
+        NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
+
+        // Used to detect if the app is running in V2 mode
+        GITBOOK_V2: 'true',
+    },
+
+    assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
+    poweredByHeader: false,
+
+    images: {
+        remotePatterns: [
+            {
+                protocol: 'https',
+                hostname: '*.gitbook.io',
+            },
+        ],
+    },
+};
+
+export default nextConfig;

packages/gitbook-v2/open-next.config.ts

@@ -0,0 +1,30 @@
+// default open-next.config.ts file created by @opennextjs/cloudflare
+
+import cache from '@opennextjs/cloudflare/kvCache';
+
+const config = {
+    default: {
+        override: {
+            wrapper: 'cloudflare-node',
+            converter: 'edge',
+            incrementalCache: async () => cache,
+            tagCache: 'dummy',
+            queue: 'dummy',
+        },
+    },
+
+    middleware: {
+        external: true,
+        override: {
+            wrapper: 'cloudflare-edge',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+        },
+    },
+
+    dangerous: {
+        enableCacheInterception: false,
+    },
+};
+
+export default config;

packages/gitbook-v2/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "gitbook-v2",
+    "version": "0.1.2",
+    "private": true,
+    "dependencies": {
+        "next": "^15.2.0",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0",
+        "@gitbook/api": "0.96.1",
+        "@gitbook/cache-tags": "workspace:*",
+        "@sindresorhus/fnv1a": "^3.1.0",
+        "server-only": "^0.0.1"
+    },
+    "devDependencies": {
+        "gitbook": "*",
+        "@opennextjs/cloudflare": "^0.5.3",
+        "tailwindcss": "^3.4.0",
+        "postcss": "^8"
+    },
+    "scripts": {
+        "generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
+        "dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
+        "build": "next build",
+        "build:v2": "next build",
+        "start": "next start",
+        "build:v2:cloudflare": "opennextjs-cloudflare",
+        "dev:v2:cloudflare": "wrangler dev --port 8771",
+        "unit": "bun test"
+    }
+}

packages/gitbook-v2/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: {
+        tailwindcss: {},
+        autoprefixer: {},
+    },
+};

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[pagePath]/loading.tsx

@@ -0,0 +1,5 @@
+import { SitePageSkeleton } from '@/components/SitePage';
+
+export default function Loading() {
+    return <SitePageSkeleton />;
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[pagePath]/not-found.tsx

@@ -0,0 +1,5 @@
+import { SitePageNotFound } from '@/components/SitePage';
+
+export default async function NotFound() {
+    return <SitePageNotFound />;
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[pagePath]/page.tsx

@@ -0,0 +1,38 @@
+import {
+    SitePage,
+    generateSitePageMetadata,
+    generateSitePageViewport,
+} from '@/components/SitePage';
+import { type RouteParams, getDynamicSiteContext, getPagePathFromParams } from '@v2/app/utils';
+import type { Metadata, Viewport } from 'next';
+
+type PageProps = {
+    params: Promise<RouteParams>;
+    searchParams: Promise<{ fallback?: string }>;
+};
+
+export default async function Page(props: PageProps) {
+    const params = await props.params;
+    const context = await getDynamicSiteContext(params);
+    const pathname = getPagePathFromParams(params);
+
+    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+}
+
+export async function generateViewport(props: PageProps): Promise<Viewport> {
+    const context = await getDynamicSiteContext(await props.params);
+    return generateSitePageViewport(context);
+}
+
+export async function generateMetadata(props: PageProps): Promise<Metadata> {
+    const [params, searchParams] = await Promise.all([props.params, props.searchParams]);
+    const context = await getDynamicSiteContext(params);
+    const pathname = getPagePathFromParams(params);
+
+    return generateSitePageMetadata({
+        context,
+        pageParams: { pathname },
+        redirectOnFallback: true,
+        fallback: !!searchParams.fallback,
+    });
+}