docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm donate Join Discord community and chat about Docsify Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Docsify turns one or more Markdown files into a Website, with no build process required.

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Support embedded files

Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use Docsify Template, review the quick start tutorial or jump right into a CodeSandbox example site with the button below.

Edit 307qqv236

Showcase

A large collection of showcase projects are included in awesome-docsify.

Links

Contributing

See CONTRIBUTING.md.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Thank you for supporting this project！:heart: [Become a sponsor]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

Special Thanks

A preview of Docsify's PR and develop branch is Powered by Vercel

docsifyjs/docsify

{
  "props": {
    "initialPayload": {
      "allShortcutsEnabled": false,
      "path": "/",
      "repo": {
        "id": 74260508,
        "defaultBranch": "develop",
        "name": "docsify",
        "ownerLogin": "docsifyjs",
        "currentUserCanPush": false,
        "isFork": false,
        "isEmpty": false,
        "createdAt": "2016-11-20T07:55:43.000Z",
        "ownerAvatar": "https://avatars.githubusercontent.com/u/40133106?v=4",
        "public": true,
        "private": false,
        "isOrgOwned": true
      },
      "currentUser": null,
      "refInfo": {
        "name": "develop",
        "listCacheKey": "v0:1721924151.0",
        "canEdit": false,
        "refType": "branch",
        "currentOid": "49f5c563a3cfeb1eadc554b890f8cd72cfd50a8f"
      },
      "tree": {
        "items": [
          {
            "name": ".github",
            "path": ".github",
            "contentType": "directory"
          },
          {
            "name": ".husky",
            "path": ".husky",
            "contentType": "directory"
          },
          {
            "name": ".vscode",
            "path": ".vscode",
            "contentType": "directory"
          },
          {
            "name": "build",
            "path": "build",
            "contentType": "directory"
          },
          {
            "name": "docs",
            "path": "docs",
            "contentType": "directory"
          },
          {
            "name": "src",
            "path": "src",
            "contentType": "directory"
          },
          {
            "name": "test",
            "path": "test",
            "contentType": "directory"
          },
          {
            "name": ".editorconfig",
            "path": ".editorconfig",
            "contentType": "file"
          },
          {
            "name": ".gitattributes",
            "path": ".gitattributes",
            "contentType": "file"
          },
          {
            "name": ".gitignore",
            "path": ".gitignore",
            "contentType": "file"
          },
          {
            "name": ".gitpod.yml",
            "path": ".gitpod.yml",
            "contentType": "file"
          },
          {
            "name": ".npmignore",
            "path": ".npmignore",
            "contentType": "file"
          },
          {
            "name": ".prettierignore",
            "path": ".prettierignore",
            "contentType": "file"
          },
          {
            "name": ".prettierrc.json",
            "path": ".prettierrc.json",
            "contentType": "file"
          },
          {
            "name": "CHANGELOG.md",
            "path": "CHANGELOG.md",
            "contentType": "file"
          },
          {
            "name": "CONTRIBUTING.md",
            "path": "CONTRIBUTING.md",
            "contentType": "file"
          },
          {
            "name": "Dockerfile",
            "path": "Dockerfile",
            "contentType": "file"
          },
          {
            "name": "HISTORY.md",
            "path": "HISTORY.md",
            "contentType": "file"
          },
          {
            "name": "LICENSE",
            "path": "LICENSE",
            "contentType": "file"
          },
          {
            "name": "README.md",
            "path": "README.md",
            "contentType": "file"
          },
          {
            "name": "SECURITY.md",
            "path": "SECURITY.md",
            "contentType": "file"
          },
          {
            "name": "babel.config.json",
            "path": "babel.config.json",
            "contentType": "file"
          },
          {
            "name": "eslint.config.js",
            "path": "eslint.config.js",
            "contentType": "file"
          },
          {
            "name": "jest.config.js",
            "path": "jest.config.js",
            "contentType": "file"
          },
          {
            "name": "middleware.js",
            "path": "middleware.js",
            "contentType": "file"
          },
          {
            "name": "package-lock.json",
            "path": "package-lock.json",
            "contentType": "file"
          },
          {
            "name": "package.json",
            "path": "package.json",
            "contentType": "file"
          },
          {
            "name": "playwright.config.js",
            "path": "playwright.config.js",
            "contentType": "file"
          },
          {
            "name": "postcss.config.cjs",
            "path": "postcss.config.cjs",
            "contentType": "file"
          },
          {
            "name": "rollup.config.js",
            "path": "rollup.config.js",
            "contentType": "file"
          },
          {
            "name": "server.configs.js",
            "path": "server.configs.js",
            "contentType": "file"
          },
          {
            "name": "server.js",
            "path": "server.js",
            "contentType": "file"
          },
          {
            "name": "vercel.json",
            "path": "vercel.json",
            "contentType": "file"
          }
        ],
        "templateDirectorySuggestionUrl": null,
        "readme": null,
        "totalCount": 33,
        "showBranchInfobar": false
      },
      "fileTree": null,
      "fileTreeProcessingTime": null,
      "foldersToFetch": [],
      "treeExpanded": false,
      "symbolsExpanded": false,
      "isOverview": true,
      "overview": {
        "banners": {
          "shouldRecommendReadme": false,
          "isPersonalRepo": false,
          "showUseActionBanner": false,
          "actionSlug": null,
          "actionId": null,
          "showProtectBranchBanner": false,
          "publishBannersInfo": {
            "dismissActionNoticePath": "/settings/dismiss-notice/publish_action_from_repo",
            "releasePath": "/docsifyjs/docsify/releases/new?marketplace=true",
            "showPublishActionBanner": false
          },
          "interactionLimitBanner": null,
          "showInvitationBanner": false,
          "inviterName": null
        },
        "codeButton": {
          "contactPath": "/contact",
          "isEnterprise": false,
          "local": {
            "protocolInfo": {
              "httpAvailable": true,
              "sshAvailable": null,
              "httpUrl": "https://github.com/docsifyjs/docsify.git",
              "showCloneWarning": null,
              "sshUrl": null,
              "sshCertificatesRequired": null,
              "sshCertificatesAvailable": null,
              "ghCliUrl": "gh repo clone docsifyjs/docsify",
              "defaultProtocol": "http",
              "newSshKeyUrl": "/settings/ssh/new",
              "setProtocolPath": "/users/set_protocol"
            },
            "platformInfo": {
              "cloneUrl": "https://desktop.github.com",
              "showVisualStudioCloneButton": false,
              "visualStudioCloneUrl": "https://windows.github.com",
              "showXcodeCloneButton": false,
              "xcodeCloneUrl": "https://developer.apple.com",
              "zipballUrl": "/docsifyjs/docsify/archive/refs/heads/develop.zip"
            }
          },
          "newCodespacePath": "/codespaces/new?hide_repo_select=true&repo=74260508"
        },
        "popovers": {
          "rename": null,
          "renamedParentRepo": null
        },
        "commitCount": "1,797",
        "overviewFiles": [
          {
            "displayName": "README.md",
            "repoName": "docsify",
            "refName": "develop",
            "path": "README.md",
            "preferredFileType": "readme",
            "tabName": "README",
            "richText": "<article class=\"markdown-body entry-content container-lg\" itemprop=\"text\"><p align=\"center\" dir=\"auto\">\n  <a href=\"https://docsify.js.org\" rel=\"nofollow\">\n    <img alt=\"docsify\" src=\"/docsifyjs/docsify/raw/develop/docs/_media/icon.svg\" style=\"max-width: 100%;\">\n  </a>\n</p>\n<p align=\"center\" dir=\"auto\">\n  A magical documentation site generator.\n</p>\n<p align=\"center\" dir=\"auto\">\n  <a href=\"#backers\"><img alt=\"Backers on Open Collective\" src=\"https://camo.githubusercontent.com/b5a7445f1be73924d41ea7eca07fc1bfe19d3e9f723c8716d155131c528b8913/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f6261636b6572732f62616467652e7376673f7374796c653d666c61742d737175617265\" data-canonical-src=\"https://opencollective.com/docsify/backers/badge.svg?style=flat-square\" style=\"max-width: 100%;\"></a>\n  <a href=\"#sponsors\">\n    <img alt=\"Sponsors on Open Collective\" src=\"https://camo.githubusercontent.com/b80afb9a8d5835204fc1f238322dc20e50507bbd319eec3aaea9fa1a2c041787/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f73706f6e736f72732f62616467652e7376673f7374796c653d666c61742d737175617265\" data-canonical-src=\"https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://github.com/docsifyjs/docsify/actions/workflows/test.yml\"><img src=\"https://github.com/docsifyjs/docsify/actions/workflows/test.yml/badge.svg\" alt=\"Build &amp; Test\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://www.npmjs.com/package/docsify\" rel=\"nofollow\"><img alt=\"npm\" src=\"https://camo.githubusercontent.com/40aacaf268e4b2a325897fdf11954407d43b64b254f510b1fc985899ff489c17/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f646f63736966792e7376673f7374796c653d666c61742d737175617265\" data-canonical-src=\"https://img.shields.io/npm/v/docsify.svg?style=flat-square\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://github.com/QingWei-Li/donate\"><img alt=\"donate\" src=\"https://camo.githubusercontent.com/2ae7be46f472922b225b5cbe0714e720e645efc07be5d76ad81b07c512c2b38e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2532342d646f6e6174652d6666363962342e7376673f7374796c653d666c61742d737175617265\" data-canonical-src=\"https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://discord.gg/3NwKFyR\" rel=\"nofollow\"><img alt=\"Join Discord community and chat about Docsify\" src=\"https://camo.githubusercontent.com/e4de4502dd5422b972f7978a6bcf3bf0340c3589070e92a9880e9ce4d2f25170/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3731333634373036363830323432313739322e7376673f6c6162656c3d266c6f676f3d646973636f7264266c6f676f436f6c6f723d66666666666626636f6c6f723d373338394438266c6162656c436f6c6f723d3641374543322663616368655365636f6e64733d3630\" data-canonical-src=\"https://img.shields.io/discord/713647066802421792.svg?label=&amp;logo=discord&amp;logoColor=ffffff&amp;color=7389D8&amp;labelColor=6A7EC2&amp;cacheSeconds=60\" style=\"max-width: 100%;\"></a>\n  <a href=\"https://gitpod.io/#https://github.com/docsifyjs/docsify\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/cfccaf0478b02ac3a1de428e0760e791b70e645273ed2dcbb32c08c8bc03b25b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f476974706f642d72656164792d2d746f2d2d636f64652d626c75653f6c6f676f3d676974706f64\" alt=\"Gitpod Ready-to-Code\" data-canonical-src=\"https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\" style=\"max-width: 100%;\"></a>\n</p>\n<p align=\"center\" dir=\"auto\">Gold Sponsor via <a href=\"https://opencollective.com/docsify\" rel=\"nofollow\">Open Collective</a></p>\n<p align=\"center\" dir=\"auto\">\n  <a href=\"https://opencollective.com/docsify/order/3254\" rel=\"nofollow\">\n    <img src=\"https://camo.githubusercontent.com/1abd55e418fcbf20f733b53b15b65091761ae010eec089237ca1eb0dd6794223/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f74696572732f676f6c642d73706f6e736f722e7376673f6176617461724865696768743d3336\" data-canonical-src=\"https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36\" style=\"max-width: 100%;\">\n  </a>\n</p>\n<p dir=\"auto\">Docsify turns one or more Markdown files into a Website, with no build process required.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Features</h2><a id=\"user-content-features\" class=\"anchor\" aria-label=\"Permalink: Features\" href=\"#features\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ul dir=\"auto\">\n<li>No statically built html files</li>\n<li>Simple and lightweight</li>\n<li>Smart full-text search plugin</li>\n<li>Multiple themes</li>\n<li>Useful plugin API</li>\n<li>Support embedded files</li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Quick Start</h2><a id=\"user-content-quick-start\" class=\"anchor\" aria-label=\"Permalink: Quick Start\" href=\"#quick-start\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Get going fast by using a static web server or GitHub Pages with this ready-to-use <a href=\"https://github.com/docsifyjs/docsify-template\">Docsify Template</a>, review the <a href=\"https://docsify.js.org/#/quickstart\" rel=\"nofollow\">quick start tutorial</a> or jump right into a CodeSandbox example site with the button below.</p>\n<p dir=\"auto\"><a href=\"https://codesandbox.io/s/307qqv236\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/97cbe82b1619b42e1f78fce9db09104b932a9da1fd37751f4d9c41f4fe350241/68747470733a2f2f636f646573616e64626f782e696f2f7374617469632f696d672f706c61792d636f646573616e64626f782e737667\" alt=\"Edit 307qqv236\" data-canonical-src=\"https://codesandbox.io/static/img/play-codesandbox.svg\" style=\"max-width: 100%;\"></a></p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Showcase</h2><a id=\"user-content-showcase\" class=\"anchor\" aria-label=\"Permalink: Showcase\" href=\"#showcase\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">A large collection of showcase projects are included in <a href=\"https://github.com/docsifyjs/awesome-docsify#showcase\">awesome-docsify</a>.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Links</h2><a id=\"user-content-links\" class=\"anchor\" aria-label=\"Permalink: Links\" href=\"#links\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<ul dir=\"auto\">\n<li><a href=\"https://docsify.js.org\" rel=\"nofollow\">Documentation</a></li>\n<li><a href=\"https://github.com/docsifyjs/docsify-cli\">Docsify CLI (Command Line Interface)</a></li>\n<li>CDN: <a href=\"https://unpkg.com/docsify/\" rel=\"nofollow\">UNPKG</a> | <a href=\"https://cdn.jsdelivr.net/npm/docsify/\" rel=\"nofollow\">jsDelivr</a> | <a href=\"https://cdnjs.com/libraries/docsify\" rel=\"nofollow\">cdnjs</a></li>\n<li><a href=\"https://docsify-preview.vercel.app/\" rel=\"nofollow\"><code>develop</code> branch preview</a></li>\n<li><a href=\"https://github.com/docsifyjs/awesome-docsify\">Awesome docsify</a></li>\n<li><a href=\"https://discord.gg/3NwKFyR\" rel=\"nofollow\">Community chat</a></li>\n</ul>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Contributing</h2><a id=\"user-content-contributing\" class=\"anchor\" aria-label=\"Permalink: Contributing\" href=\"#contributing\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">See <a href=\"/docsifyjs/docsify/blob/develop/CONTRIBUTING.md\">CONTRIBUTING.md</a>.</p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Backers</h2><a id=\"user-content-backers\" class=\"anchor\" aria-label=\"Permalink: Backers\" href=\"#backers\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Thank you to all our backers! 🙏 [<a href=\"https://opencollective.com/docsify#backers\" rel=\"nofollow\">Become a backer</a>]</p>\n<p dir=\"auto\"><a href=\"https://opencollective.com/docsify#backers\" rel=\"nofollow\"><img src=\"https://camo.githubusercontent.com/f5899ee80e06936b0cfa4a36f6b825c5f615181f7f0ae6fa44e26f14a5e9d9ea/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f6261636b6572732e7376673f77696474683d383930\" data-canonical-src=\"https://opencollective.com/docsify/backers.svg?width=890\" style=\"max-width: 100%;\"></a></p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Sponsors</h2><a id=\"user-content-sponsors\" class=\"anchor\" aria-label=\"Permalink: Sponsors\" href=\"#sponsors\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">Thank you for supporting this project！:heart: [<a href=\"https://opencollective.com/docsify\" rel=\"nofollow\">Become a sponsor</a>]</p>\n<p dir=\"auto\"><a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"https://camo.githubusercontent.com/e5748f6a04e76b40cbbed2930a2212be694d4eddbde2cc8bcc0d0f8a112e78e8/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f73706f6e736f72732e7376673f77696474683d383930\"><img src=\"https://camo.githubusercontent.com/e5748f6a04e76b40cbbed2930a2212be694d4eddbde2cc8bcc0d0f8a112e78e8/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f73706f6e736f72732e7376673f77696474683d383930\" data-canonical-src=\"https://opencollective.com/docsify/sponsors.svg?width=890\" style=\"max-width: 100%;\"></a></p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Contributors</h2><a id=\"user-content-contributors\" class=\"anchor\" aria-label=\"Permalink: Contributors\" href=\"#contributors\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">This project exists thanks to all the people who contribute. [<a href=\"/docsifyjs/docsify/blob/develop/CONTRIBUTING.md\">Contribute</a>].\n<a href=\"https://github.com/docsifyjs/docsify/graphs/contributors\"><img src=\"https://camo.githubusercontent.com/6c2cdc5e1d70ce0fbc83f176c24f16ee9541d319c00cb089ed0cb1d7b8384551/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f646f63736966792f636f6e7472696275746f72732e7376673f77696474683d383930\" data-canonical-src=\"https://opencollective.com/docsify/contributors.svg?width=890\" style=\"max-width: 100%;\"></a></p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">License</h2><a id=\"user-content-license\" class=\"anchor\" aria-label=\"Permalink: License\" href=\"#license\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\"><a href=\"/docsifyjs/docsify/blob/develop/LICENSE\">MIT</a></p>\n<div class=\"markdown-heading\" dir=\"auto\"><h2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\">Special Thanks</h2><a id=\"user-content-special-thanks\" class=\"anchor\" aria-label=\"Permalink: Special Thanks\" href=\"#special-thanks\"><svg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"><path d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"></path></svg></a></div>\n<p dir=\"auto\">A preview of Docsify's PR and develop branch is <a href=\"https://vercel.com/?utm_source=docsifyjs&amp;utm_campaign=oss\" rel=\"nofollow\">Powered by <img src=\"https://camo.githubusercontent.com/dea833129e6edef3c91020953a6639653fecda41b6063ceb3f2312bf163472db/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f646f63736966796a732f646f63736966792f646f63732f5f6d656469612f76657263656c5f6c6f676f2e737667\" alt=\"Vercel\" width=\"133px\" data-canonical-src=\"https://cdn.jsdelivr.net/gh/docsifyjs/docsify/docs/_media/vercel_logo.svg\" style=\"max-width: 100%;\"></a></p>\n</article>",
            "loaded": true,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": [
                {
                  "level": 2,
                  "text": "Features",
                  "anchor": "features",
                  "htmlText": "Features"
                },
                {
                  "level": 2,
                  "text": "Quick Start",
                  "anchor": "quick-start",
                  "htmlText": "Quick Start"
                },
                {
                  "level": 2,
                  "text": "Showcase",
                  "anchor": "showcase",
                  "htmlText": "Showcase"
                },
                {
                  "level": 2,
                  "text": "Links",
                  "anchor": "links",
                  "htmlText": "Links"
                },
                {
                  "level": 2,
                  "text": "Contributing",
                  "anchor": "contributing",
                  "htmlText": "Contributing"
                },
                {
                  "level": 2,
                  "text": "Backers",
                  "anchor": "backers",
                  "htmlText": "Backers"
                },
                {
                  "level": 2,
                  "text": "Sponsors",
                  "anchor": "sponsors",
                  "htmlText": "Sponsors"
                },
                {
                  "level": 2,
                  "text": "Contributors",
                  "anchor": "contributors",
                  "htmlText": "Contributors"
                },
                {
                  "level": 2,
                  "text": "License",
                  "anchor": "license",
                  "htmlText": "License"
                },
                {
                  "level": 2,
                  "text": "Special Thanks",
                  "anchor": "special-thanks",
                  "htmlText": "Special Thanks"
                }
              ],
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify"
            }
          },
          {
            "displayName": "CODE_OF_CONDUCT.md",
            "repoName": ".github",
            "refName": "main",
            "path": "CODE_OF_CONDUCT.md",
            "preferredFileType": "code_of_conduct",
            "tabName": "Code of conduct",
            "richText": null,
            "loaded": false,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": null,
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify"
            }
          },
          {
            "displayName": "LICENSE",
            "repoName": "docsify",
            "refName": "develop",
            "path": "LICENSE",
            "preferredFileType": "license",
            "tabName": "License",
            "richText": null,
            "loaded": false,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": null,
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify"
            }
          },
          {
            "displayName": "SECURITY.md",
            "repoName": "docsify",
            "refName": "develop",
            "path": "SECURITY.md",
            "preferredFileType": "security",
            "tabName": "Security",
            "richText": null,
            "loaded": false,
            "timedOut": false,
            "errorMessage": null,
            "headerInfo": {
              "toc": null,
              "siteNavLoginPath": "/login?return_to=https%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify"
            }
          }
        ],
        "overviewFilesProcessingTime": 0
      }
    },
    "appPayload": {
      "helpUrl": "https://docs.github.com",
      "findFileWorkerPath": "/assets-cdn/worker/find-file-worker-1583894afd38.js",
      "findInFileWorkerPath": "/assets-cdn/worker/find-in-file-worker-3a63a487027b.js",
      "githubDevUrl": null,
      "enabled_features": {
        "code_nav_ui_events": false,
        "overview_shared_code_dropdown_button": false,
        "react_blob_overlay": false,
        "copilot_conversational_ux_embedding_update": false,
        "copilot_smell_icebreaker_ux": true,
        "copilot_workspace": false
      }
    }
  }
}
{
  "accept-ranges": "bytes",
  "cache-control": "max-age=0, private, must-revalidate",
  "content-encoding": "gzip",
  "content-security-policy": "default-src 'none'; base-uri 'self'; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com api.githubcopilot.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com/v1/engines/github-completion/completions proxy.enterprise.githubcopilot.com/v1/engines/github-completion/completions *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/",
  "content-type": "text/html; charset=utf-8",
  "date": "Sat, 27 Jul 2024 07:43:26 GMT",
  "etag": "55e1166b9e5f518c823d129b2df2ab86",
  "referrer-policy": "no-referrer-when-downgrade",
  "server": "GitHub.com",
  "set-cookie": "logged_in=no; Path=/; Domain=github.com; Expires=Sun, 27 Jul 2025 07:43:26 GMT; HttpOnly; Secure; SameSite=Lax",
  "strict-transport-security": "max-age=31536000; includeSubdomains; preload",
  "transfer-encoding": "chunked",
  "vary": "X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, Accept-Encoding, Accept, X-Requested-With",
  "x-content-type-options": "nosniff",
  "x-frame-options": "deny",
  "x-github-request-id": "DF64:3C2CC5:2D736EE:3C23F8A:66A4A51E",
  "x-xss-protection": "0"
}