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
- Emoji support
## Quick Start
Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.
[](https://codesandbox.io/s/307qqv236)
## Showcase
A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).
## Links
- [Documentation](https://docsify.js.org)
- [Docsify CLI (Command Line Interface)](https://github.com/docsifyjs/docsify-cli)
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
- [`develop` branch preview](https://docsify-preview.vercel.app/)
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
- [Community chat](https://discord.gg/3NwKFyR)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify/contribute)]
## Sponsors
Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)]
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
## License
[MIT](LICENSE)
================================================
FILE: SECURITY.md
================================================
# Security Policy
If you believe you have found a security vulnerability in docsify, please report it to us asap.
## Reporting a Vulnerability
**Please do not report security vulnerabilities through our public GitHub issues.**
Send email to us via :email: maintainers@docsifyjs.org.
Please include as much of the following information as possible to help us better understand the possible issue:
- Type of issue (e.g. cross-site scripting)
- Full paths of source file(s) related to the manifestation of the issue
- The location of the affected source code (tag/branch/commit or direct URL)
- Any special configuration required to reproduce the issue
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code
- Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
Thank you in advance.
================================================
FILE: babel.config.json
================================================
{
"presets": [
[
"@babel/preset-env",
{
"targets": "defaults"
}
]
]
}
================================================
FILE: build/cover.js
================================================
import fs from 'fs';
import { relative } from './util.js';
const read = fs.readFileSync;
const write = fs.writeFileSync;
const pkgPath = relative(import.meta, '..', 'package.json');
const pkg = JSON.parse(read(pkgPath).toString());
const version = process.env.VERSION || pkg.version;
const file = relative(import.meta, '..', 'docs', '_coverpage.md');
let cover = read(file, 'utf8').toString();
console.log('Replace version number in cover page...');
cover = cover.replace(
/(\S+)?<\/small>/g,
/* html */ `${version}`,
);
write(file, cover);
================================================
FILE: build/emoji.js
================================================
import fs from 'fs';
import path from 'path';
import axios from 'axios';
const filePaths = {
emojiMarkdown: path.resolve(process.cwd(), 'docs', 'emoji.md'),
emojiJS: path.resolve(
process.cwd(),
'src',
'core',
'render',
'emoji-data.js',
),
};
async function getEmojiData() {
const emojiDataURL = 'https://api.github.com/emojis';
console.info(`- Fetching emoji data from ${emojiDataURL}`);
const response = await axios.get(emojiDataURL);
const baseURL = Object.values(response.data)
.find(url => /unicode\//)
.split('unicode/')[0];
const data = { ...response.data };
// Remove base URL from emoji URLs
Object.entries(data).forEach(
([key, value]) => (data[key] = value.replace(baseURL, '')),
);
console.info(`- Retrieved ${Object.keys(data).length} emoji entries`);
return {
baseURL,
data,
};
}
function writeEmojiPage(emojiData) {
const isExistingPage = fs.existsSync(filePaths.emojiMarkdown);
const emojiPage =
(isExistingPage && fs.readFileSync(filePaths.emojiMarkdown, 'utf8')) ||
'\n\n';
const emojiRegEx = /(\n)([\s\S]*)(\n)/;
const emojiMatch = emojiPage.match(emojiRegEx);
const emojiMarkdownStart = emojiMatch[1].trim();
const emojiMarkdown = emojiMatch[2].trim();
const emojiMarkdownEnd = emojiMatch[3].trim();
const newEmojiMarkdown = Object.keys(emojiData.data)
.reduce(
(preVal, curVal) =>
(preVal += `:${curVal}: ` + '`' + `:${curVal}:` + '`' + '\n\n'),
'',
)
.trim();
if (emojiMarkdown !== newEmojiMarkdown) {
const newEmojiPage = emojiPage.replace(
emojiMatch[0],
`${emojiMarkdownStart}\n\n${newEmojiMarkdown}\n\n${emojiMarkdownEnd}`,
);
fs.writeFileSync(filePaths.emojiMarkdown, newEmojiPage);
console.info(
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiMarkdown}`,
);
} else {
console.info(`- No changes: ${filePaths.emojiMarkdown}`);
}
}
function writeEmojiJS(emojiData) {
const isExistingPage = fs.existsSync(filePaths.emojiJS);
const emojiJS = isExistingPage && fs.readFileSync(filePaths.emojiJS, 'utf8');
const newEmojiJS = [
'// =============================================================================',
'// DO NOT EDIT: This file is auto-generated by an /build/emoji.js',
'// =============================================================================\n',
`export default ${JSON.stringify(emojiData, {}, 2)}`,
].join('\n');
if (!emojiJS || emojiJS !== newEmojiJS) {
fs.writeFileSync(filePaths.emojiJS, newEmojiJS);
console.info(
`- ${!isExistingPage ? 'Created' : 'Updated'}: ${filePaths.emojiJS}`,
);
} else {
console.info(`- No changes: ${filePaths.emojiJS}`);
}
}
console.info('Build emoji');
const emojiData = await getEmojiData();
writeEmojiPage(emojiData);
writeEmojiJS(emojiData);
console.info('Finish update');
================================================
FILE: build/release.sh
================================================
set -e
if [[ -z $1 ]]; then
echo "Enter new version: "
read VERSION
else
VERSION=$1
fi
RELEASE_TAG=${RELEASE_TAG:-""}
if [[ -n "$RELEASE_TAG" && "$VERSION" != *"$RELEASE_TAG"* ]]; then
RELEASE_MSG="$VERSION ($RELEASE_TAG)"
else
RELEASE_MSG="$VERSION"
fi
read -p "Releasing $VERSION $RELEASE_TAG - are you sure? (y/n) " -n 1 -r
echo
if [[ $REPLY =~ ^[Yy]$ ]]; then
echo "Releasing $VERSION ..."
# Update version (don't commit or tag yet)
npm --no-git-tag-version version "$VERSION"
# Build and test
npm run build
npm run test:update:snapshot
npm run test
git stash
npm run build:v4 # builds legacy v4 lib/ and themes/ folders for backwards compat while people transition to v5.
git stash pop
# Changelog
npx conventional-changelog -p angular -i CHANGELOG.md -s
# Commit all changes
git add -A
git commit -m "[release] $RELEASE_MSG"
# Tag and push
git tag "v$VERSION"
git push origin "v$VERSION"
git push
# Publish to npm
if [[ -z $RELEASE_TAG ]]; then
npm publish
else
npm publish --tag "$RELEASE_TAG"
fi
npm run clean:v4 # clean up legacy v4 build files
fi
================================================
FILE: build/util.js
================================================
import url from 'url';
import path from 'path';
/** Get a new path relative to the current module (pass import.meta). */
export const relative = (meta, ...to) =>
path.resolve(path.dirname(url.fileURLToPath(meta.url)), ...to);
================================================
FILE: docs/.nojekyll
================================================
================================================
FILE: docs/CNAME
================================================
docsify.js.org
================================================
FILE: docs/README.md
================================================
# docsify
> A magical documentation site generator.
## What it is
Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an `index.html` file and [deploy it on GitHub Pages](deploy.md) (for more details see the [Quick start](quickstart.md) guide).
## Features
- No statically built HTML files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support
## Examples
Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see docsify in use.
## Donate
Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
## Community
Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).
================================================
FILE: docs/_coverpage.md
================================================
# docsify 5.0.0-rc.4 :id=docsify
> A magical documentation site generator
- Simple and lightweight
- No statically built HTML files
- Multiple themes
[Get Started](#docsify)
[GitHub](https://github.com/docsifyjs/docsify/)
================================================
FILE: docs/_media/example-with-yaml.md
================================================
---
author: John Smith
date: 2020-1-1
---
> This is from the `example-with-yaml.md`
================================================
FILE: docs/_media/example.html
================================================
Example HTML Page
================================================
FILE: docs/_media/example.js
================================================
import fetch from 'fetch';
const URL = 'https://example.com';
const PORT = 8080;
/// [demo]
const result = fetch(`${URL}:${PORT}`)
.then(response => {
return response.json();
})
.then(myJson => {
console.log(JSON.stringify(myJson));
});
/// [demo]
result.then(console.log).catch(console.error);
================================================
FILE: docs/_media/example.md
================================================
> This is from the `example.md`
================================================
FILE: docs/_navbar.md
================================================
- Translations
- [English](/)
- [简体中文](/zh-cn/)
================================================
FILE: docs/_sidebar.md
================================================
- Getting started
- [Quick start](quickstart.md)
- [Adding pages](adding-pages.md)
- [Cover page](cover.md)
- [Custom navbar](custom-navbar.md)
- Customization
- [Configuration](configuration.md)
- [Themes](themes.md)
- [List of Plugins](plugins.md)
- [Write a Plugin](write-a-plugin.md)
- [Markdown configuration](markdown.md)
- [Language highlighting](language-highlight.md)
- [Emoji](emoji.md)
- Guide
- [Deploy](deploy.md)
- [Helpers](helpers.md)
- [Vue compatibility](vue.md)
- [CDN](cdn.md)
- [Offline Mode (PWA)](pwa.md)
- [Embed Files](embed-files.md)
- [UI Kit](ui-kit.md)
- Upgrading
- [v4 to v5](v5-upgrade.md)
* [Awesome docsify](awesome.md)
* [Changelog](changelog.md)
================================================
FILE: docs/adding-pages.md
================================================
# Adding pages
If you need more pages, you can simply create more markdown files in your docsify directory. If you create a file named `guide.md`, then it is accessible via `/#/guide`.
For example, the directory structure is as follows:
```text
.
└── docs
├── README.md
├── guide.md
└── zh-cn
├── README.md
└── guide.md
```
Matching routes
```text
docs/README.md => http://domain.com
docs/guide.md => http://domain.com/#/guide
docs/zh-cn/README.md => http://domain.com/#/zh-cn/
docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide
```
## Sidebar
In order to have a sidebar, you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/main/docs/_sidebar.md) for an example):
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration#loadsidebar).
```html
```
Create the `_sidebar.md`:
```markdown
- [Home](/)
- [Page 1](page-1.md)
```
To create section headers:
```markdown
- Section Header 1
- [Home](/)
- [Page 1](page-1.md)
- Section Header 2
- [Page 2](page-2.md)
- [Page 3](page-3.md)
```
You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
> [!IMPORTANT] Docsify only looks for `_sidebar.md` in the current folder, and uses that, otherwise it falls back to the one configured using `window.$docsify.loadSidebar` config.
Example file structure:
```text
└── docs/
├── _sidebar.md
├── index.md
├── getting-started.md
└── running-services.md
```
## Nested Sidebars
You may want the sidebar to update after navigation to reflect the current directory. This can be done by adding a `_sidebar.md` file to each folder.
`_sidebar.md` is loaded from each level directory. If the current directory doesn't have `_sidebar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
You can specify `alias` to avoid unnecessary fallback.
```html
```
> [!IMPORTANT] You can create a `README.md` file in a subdirectory to use it as the landing page for the route.
## Set Page Titles from Sidebar Selection
A page's `title` tag is generated from the _selected_ sidebar item name. For better SEO, you can customize the title by specifying a string after the filename.
```markdown
- [Home](/)
- [Guide](guide.md 'The greatest guide in the world')
```
## Table of Contents
Once you've created `_sidebar.md`, the sidebar content is automatically generated based on the headers in the markdown files.
A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [subMaxLevel configuration](configuration#submaxlevel).
```html
```
## Ignoring Subheaders
When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `` to it.
```markdown
# Getting Started
## Header
This header won't appear in the sidebar table of contents.
```
To ignore all headers on a specific page, you can use `` on the first header of the page.
```markdown
# Getting Started
## Header
This header won't appear in the sidebar table of contents.
```
Both `` and `` will not be rendered on the page when used.
And the `{docsify-ignore}` and `{docsify-ignore-all}` can do the samething as well.
================================================
FILE: docs/cdn.md
================================================
# CDN
The docsify [npm package](https://www.npmjs.com/package/docsify) is auto-published to CDNs with each release. The contents can be viewed on each CDN.
Docsify recommends [jsDelivr](//cdn.jsdelivr.net) as its preferred CDN:
- https://cdn.jsdelivr.net/npm/docsify/
Other CDNs are available and may be required in locations where jsDelivr is not available:
- https://cdnjs.com/libraries/docsify
- https://unpkg.com/browse/docsify/
- https://www.bootcdn.cn/docsify/
## Specifying versions
Note the `@` version lock in the CDN URLs below. This allows specifying the latest major, minor, patch, or specific [semver](https://semver.org) version number.
- MAJOR versions include breaking changes
`1.0.0` → `2.0.0`
- MINOR versions include non-breaking new functionality
`1.0.0` → `1.1.0`
- PATCH versions include non-breaking bug fixes
`1.0.0` → `1.0.1`
Uncompressed resources are available by omitting the `.min` from the filename.
## Latest "major" version
Specifying the latest major version allows your site to receive all non-breaking enhancements ("minor" updates) and bug fixes ("patch" updates) as they are released. This is good option for those who prefer a zero-maintenance way of keeping their site up to date with minimal risk as new versions are published.
> [!TIP] When a new major version is released, you will need to manually update the major version number after the `@` symbol in your CDN URLs.
```html
```
## Specific version
Specifying an exact version prevents any future updates from affecting your site. This is good option for those who prefer to manually update their resources as new versions are published.
> [!TIP] When a new version is released, you will need to manually update the version number after the `@` symbol in your CDN URLs.
```html
```
================================================
FILE: docs/configuration.md
================================================
# Configuration
You can configure Docsify by defining `window.$docsify` as an object:
```html
```
The config can also be defined as a function, in which case the first argument is the Docsify `vm` instance. The function should return a config object. This can be useful for referencing `vm` in places like the markdown configuration:
```html
```
## alias
- Type: `Object`
Set the route alias. You can freely manage routing rules. Supports RegExp.
Do note that order matters! If a route can be matched by multiple aliases, the one you declared first takes precedence.
```js
window.$docsify = {
alias: {
'/foo/(.*)': '/bar/$1', // supports regexp
'/zh-cn/changelog': '/changelog',
'/changelog':
'https://raw.githubusercontent.com/docsifyjs/docsify/main/CHANGELOG',
// You may need this if you use routerMode:'history'.
'/.*/_sidebar.md': '/_sidebar.md', // See #301
},
};
```
> **Note** If you change [`routerMode`](#routermode) to `'history'`, you may
> want to configure an alias for your `_sidebar.md` and `_navbar.md` files.
## auto2top
- Type: `Boolean`
- Default: `false`
Scrolls to the top of the screen when the route is changed.
```js
window.$docsify = {
auto2top: true,
};
```
## autoHeader
- Type: `Boolean`
- Default: `false`
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML — but only if the page does not already contain an H1 heading.
For more details, see [#78](https://github.com/docsifyjs/docsify/issues/78).
```js
window.$docsify = {
loadSidebar: true,
autoHeader: true,
};
```
## basePath
- Type: `String`
Base path of the website. You can set it to another directory or another domain name.
```js
window.$docsify = {
basePath: '/path/',
// Load the files from another site
basePath: 'https://docsify.js.org/',
// Even can load files from other repo
basePath:
'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/',
};
```
## catchPluginErrors
- Type: `Boolean`
- Default: `true`
Determines if Docsify should handle uncaught _synchronous_ plugin errors automatically. This can prevent plugin errors from affecting docsify's ability to properly render live site content.
## cornerExternalLinkTarget
- Type: `String`
- Default: `'_blank'`
Target to open external link at the top right corner. Default `'_blank'` (new window/tab)
```js
window.$docsify = {
cornerExternalLinkTarget: '_self', // default: '_blank'
};
```
## coverpage
- Type: `Boolean|String|String[]|Object`
- Default: `false`
Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`.
```js
window.$docsify = {
coverpage: true,
// Custom file name
coverpage: 'cover.md',
// multiple covers
coverpage: ['/', '/zh-cn/'],
// multiple covers and custom file name
coverpage: {
'/': 'cover.md',
'/zh-cn/': 'cover.md',
},
};
```
## el
- Type: `String`
- Default: `'#app'`
The DOM element to be mounted on initialization. It can be a CSS selector string or an actual [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement).
```js
window.$docsify = {
el: '#app',
};
```
## executeScript
- Type: `Boolean`
- Default: `null`
Execute the script on the page. Only parses the first script tag ([demo](themes)). If Vue is detected, this is `true` by default.
```js
window.$docsify = {
executeScript: true,
};
```
```markdown
## This is test
```
Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins.md?id=external-script) plugin.
## ext
- Type: `String`
- Default: `'.md'`
Request file extension.
```js
window.$docsify = {
ext: '.md',
};
```
## externalLinkRel
- Type: `String`
- Default: `'noopener'`
Default `'noopener'` (no opener) prevents the newly opened external page (when [externalLinkTarget](#externallinktarget) is `'_blank'`) from having the ability to control our page. No `rel` is set when it's not `'_blank'`. See [this post](https://mathiasbynens.github.io/rel-noopener/) for more information about why you may want to use this option.
```js
window.$docsify = {
externalLinkRel: '', // default: 'noopener'
};
```
## externalLinkTarget
- Type: `String`
- Default: `'_blank'`
Target to open external links inside the markdown. Default `'_blank'` (new window/tab)
```js
window.$docsify = {
externalLinkTarget: '_self', // default: '_blank'
};
```
## fallbackLanguages
- Type: `Array`
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given locale.
Example:
- try to fetch the page of `/de/overview`. If this page exists, it'll be displayed.
- then try to fetch the default page `/overview` (depending on the default language). If this page exists, it'll be displayed.
- then display the 404 page.
```js
window.$docsify = {
fallbackLanguages: ['fr', 'de'],
};
```
## fallbackDefaultLanguage
- Type: `String`
- Default: `''`
When a page is requested and it doesn't exist for the given locale, Docsify will fallback to the language specified by this option.
For example, in the scenario described above, if `/de/overview` does not exist and `fallbackDefaultLanguage` is configured as `zh-cn`, Docsify will fetch `/zh-cn/overview` instead of `/overview`.
```js
window.$docsify = {
fallbackLanguages: ['fr', 'de'],
fallbackDefaultLanguage: 'zh-cn', // default: ''
};
```
## formatUpdated
- Type: `String|Function`
We can display the file update date through **{docsify-updated}** variable. And format it by `formatUpdated`.
See https://github.com/lukeed/tinydate#patterns
```js
window.$docsify = {
formatUpdated: '{MM}/{DD} {HH}:{mm}',
formatUpdated(time) {
// ...
return time;
},
};
```
## hideSidebar
- Type : `Boolean`
- Default: `false`
This option will completely hide your sidebar and won't render any content on the side.
```js
window.$docsify = {
hideSidebar: true,
};
```
## homepage
- Type: `String`
- Default: `'README.md'`
`README.md` in your docs folder will be treated as the homepage for your website, but sometimes you may need to serve another file as your homepage.
```js
window.$docsify = {
// Change to /home.md
homepage: 'home.md',
// Or use the readme in your repo
homepage:
'https://raw.githubusercontent.com/docsifyjs/docsify/main/README.md',
};
```
## keyBindings
- Type: `Boolean|Object`
- Default: `Object`
- \\ Toggle the sidebar menu
- / Focus on [search](plugins#full-text-search) field. Also supports alt / ctrl + k.
Binds key combination(s) to a custom callback function.
Key `bindings` are defined as case insensitive string values separated by `+`. Modifier key values include `alt`, `ctrl`, `meta`, and `shift`. Non-modifier key values should match the keyboard event's [key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) or [code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code) value.
The `callback` function receive a [keydown event](https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event) as an argument.
> [!IMPORTANT] Let site visitors know your custom key bindings are available! If a binding is associated with a DOM element, consider inserting a `` element as a visual cue (e.g., alt + a) or adding [title](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) and [aria-keyshortcuts](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts) attributes for hover/focus hints.
```js
window.$docsify = {
keyBindings: {
// Custom key binding
myCustomBinding: {
bindings: ['alt+a', 'shift+a'],
callback(event) {
alert('Hello, World!');
},
},
},
};
```
Key bindings can be disabled entirely or individually by setting the binding configuration to `false`.
```js
window.$docsify = {
// Disable all key bindings
keyBindings: false,
};
```
```js
window.$docsify = {
keyBindings: {
// Disable individual key bindings
focusSearch: false,
toggleSidebar: false,
},
};
```
## loadNavbar
- Type: `Boolean|String`
- Default: `false`
Loads navbar from the Markdown file `_navbar.md` if **true**, else loads it from the path specified.
```js
window.$docsify = {
// load from _navbar.md
loadNavbar: true,
// load from nav.md
loadNavbar: 'nav.md',
};
```
## loadSidebar
- Type: `Boolean|String`
- Default: `false`
Loads sidebar from the Markdown file `_sidebar.md` if **true**, else loads it from the path specified.
```js
window.$docsify = {
// load from _sidebar.md
loadSidebar: true,
// load from summary.md
loadSidebar: 'summary.md',
};
```
## logo
- Type: `String`
Website logo as it appears in the sidebar. You can resize it using CSS.
> [!IMPORTANT] Logo will only be visible if `name` prop is also set. See [name](#name) configuration.
```js
window.$docsify = {
logo: '/_media/icon.svg',
};
```
## markdown
- Type: `Function`
See [Markdown configuration](markdown.md).
```js
window.$docsify = {
// object
markdown: {
smartypants: true,
renderer: {
link() {
// ...
},
},
},
// function
markdown(marked, renderer) {
// ...
return marked;
},
};
```
## maxLevel
- Type: `Number`
- Default: `6`
Maximum Table of content level.
```js
window.$docsify = {
maxLevel: 4,
};
```
## mergeNavbar
- Type: `Boolean`
- Default: `false`
Navbar will be merged with the sidebar on smaller screens.
```js
window.$docsify = {
mergeNavbar: true,
};
```
## name
- Type: `Boolean | String`
Website name as it appears in the sidebar.
```js
window.$docsify = {
name: 'docsify',
};
```
The name field can also contain custom HTML for easier customization:
```js
window.$docsify = {
name: 'docsify',
};
```
If `true`, the website name will be inferred from the document's `` tag.
```js
window.$docsify = {
name: true,
};
```
If `false` or empty, no name will be displayed.
```js
window.$docsify = {
name: false,
};
```
## nameLink
- Type: `String`
- Default: `'window.location.pathname'`
The URL that the website `name` links to.
```js
window.$docsify = {
nameLink: '/',
// For each route
nameLink: {
'/zh-cn/': '#/zh-cn/',
'/': '#/',
},
};
```
## nativeEmoji
- Type: `Boolean`
- Default: `false`
Render emoji shorthand codes using GitHub-style emoji images or native emoji characters.
```js
window.$docsify = {
nativeEmoji: true,
};
```
```markdown
:smile:
:partying_face:
:joy:
:+1:
:-1:
```
GitHub-style images when `false`:
<output data-lang="output">
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f604.png" alt="smile">
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f973.png" alt="partying_face">
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f602.png" alt="joy">
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png" alt="+1">
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" alt="-1">
</output>
Native characters when `true`:
<output data-lang="output">
<span class="emoji">😄︎</span>
<span class="emoji">🥳︎</span>
<span class="emoji">😂︎</span>
<span class="emoji">👍︎</span>
<span class="emoji">👎︎</span>
</output>
To render shorthand codes as text, replace `:` characters with the `:` HTML entity.
```markdown
:100:
```
<output data-lang="output">
:100:
</output>
## noCompileLinks
- Type: `Array<string>`
Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203). We can skip compiling of certain links by specifying an array of strings. Each string is converted into to a regular expression (`RegExp`) and the _whole_ href of a link is matched against it.
```js
window.$docsify = {
noCompileLinks: ['/foo', '/bar/.*'],
};
```
## noEmoji
- Type: `Boolean`
- Default: `false`
Disabled emoji parsing and render all emoji shorthand as text.
```js
window.$docsify = {
noEmoji: true,
};
```
```markdown
:100:
```
<output data-lang="output">
:100:
</output>
To disable emoji parsing of individual shorthand codes, replace `:` characters with the `:` HTML entity.
```markdown
:100:
:100:
```
<output data-lang="output">
:100:
:100:
</output>
## notFoundPage
- Type: `Boolean|String|Object`
- Default: `false`
Display default "404 - Not Found" message:
```js
window.$docsify = {
notFoundPage: false,
};
```
Load the `_404.md` file:
```js
window.$docsify = {
notFoundPage: true,
};
```
Load the customized path of the 404 page:
```js
window.$docsify = {
notFoundPage: 'my404.md',
};
```
Load the right 404 page according to the localization:
```js
window.$docsify = {
notFoundPage: {
'/': '_404.md',
'/de': 'de/_404.md',
},
};
```
> Note: The options for fallbackLanguages don't work with the `notFoundPage` options.
## onlyCover
- Type: `Boolean`
- Default: `false`
Only coverpage is loaded when visiting the home page.
```js
window.$docsify = {
onlyCover: false,
};
```
## plugins
See [Plugins](./plugins.md).
## relativePath
- Type: `Boolean`
- Default: `false`
If **true**, links are relative to the current context.
For example, the directory structure is as follows:
```text
.
└── docs
├── README.md
├── guide.md
└── zh-cn
├── README.md
├── guide.md
└── config
└── example.md
```
With relative path **enabled** and current URL `http://domain.com/zh-cn/README`, given links will resolve to:
```text
guide.md => http://domain.com/zh-cn/guide
config/example.md => http://domain.com/zh-cn/config/example
../README.md => http://domain.com/README
/README.md => http://domain.com/README
```
```js
window.$docsify = {
// Relative path enabled
relativePath: true,
// Relative path disabled (default value)
relativePath: false,
};
```
## repo
- Type: `String`
Configure the repository url, or a string of `username/repo`, to add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
```js
window.$docsify = {
repo: 'docsifyjs/docsify',
// or
repo: 'https://github.com/docsifyjs/docsify/',
};
```
If undefined or empty, no GitHub corner will be displayed.
## requestHeaders
- Type: `Object`
Set the request resource headers.
```js
window.$docsify = {
requestHeaders: {
'x-token': 'xxx',
},
};
```
Such as setting the cache
```js
window.$docsify = {
requestHeaders: {
'cache-control': 'max-age=600',
},
};
```
## routerMode
Configure the URL format that the paths of your site will use.
- Type: `String`
- Default: `'hash'`
```js
window.$docsify = {
routerMode: 'history', // default: 'hash'
};
```
For statically-deployed sites (f.e. on GitHub Pages) hash-based routing is
simpler to set up. For websites that can re-write URLs, the history-based format
is better (especially for search-engine optimization, hash-based routing is not
so search-engine friendly)
Hash-based routing means all URL paths will be prefixed with `/#/` in the
address bar. This is a trick that allows the site to load `/index.html`, then it
uses the path that follows the `#` to determine what markdown files to load. For
example, a complete hash-based URL may look like this:
`https://example.com/#/path/to/page`. The browser will actually load
`https://example.com` (assuming your static server serves
`index.html` by default, as most do), and then the Docsify JavaScript code will
look at the `/#/...` and determine the markdown file to load and render.
Additionally, when clicking on a link, the Docsify router will change the
content after the hash dynamically. The value of `location.pathname` will still be
`/` no matter what. The parts of a hash path are _not_ sent to the server when
visiting such a URL in a browser.
On the other hand, history-based routing means the Docsify JavaScript will use
the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API)
to dynamically change the URL without using a `#`. This means that all URLs will
be considered "real" by search engines, and the full path will be sent to the
server when visiting the URL in your browser. For example, a URL may look like
`https://example.com/path/to/page`. The browser will try to load that full URL
directly from the server, not just `https://example.com`. The upside of this is
that these types of URLs are much more friendly for search engines, and can be
indexed (yay!). The downside, however, is that your server, or the place where
you host your site files, has to be able to handle these URLs. Various static
website hosting services allow "rewrite rules" to be configured, such that a
server can be configured to always send back `/index.html` no matter what path
is visited. The value of `location.pathname` will show `/path/to/page`, because
it was actually sent to the server.
TLDR: start with `hash` routing (the default). If you feel adventurous, learn
how to configure a server, then switch to `history` mode for better experience
without the `#` in the URL and SEO optimization.
> **Note** If you use `routerMode: 'history'`, you may want to add an
> [`alias`](#alias) to make your `_sidebar.md` and `_navbar.md` files always be
> loaded no matter which path is being visited.
>
> ```js
> window.$docsify = {
> routerMode: 'history',
> alias: {
> '/.*/_sidebar.md': '/_sidebar.md',
> '/.*/_navbar.md': '/_navbar.md',
> },
> };
> ```
## routes
- Type: `Object`
Define "virtual" routes that can provide content dynamically. A route is a map between the expected path, to either a string or a function. If the mapped value is a string, it is treated as markdown and parsed accordingly. If it is a function, it is expected to return markdown content.
A route function receives up to three parameters:
1. `route` - the path of the route that was requested (e.g. `/bar/baz`)
2. `matched` - the [`RegExpMatchArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match) that was matched by the route (e.g. for `/bar/(.+)`, you get `['/bar/baz', 'baz']`)
3. `next` - this is a callback that you may call when your route function is async
Do note that order matters! Routes are matched the same order you declare them in, which means that in cases where you have overlapping routes, you might want to list the more specific ones first.
```js
window.$docsify = {
routes: {
// Basic match w/ return string
'/foo': '# Custom Markdown',
// RegEx match w/ synchronous function
'/bar/(.*)'(route, matched) {
return '# Custom Markdown';
},
// RegEx match w/ asynchronous function
'/baz/(.*)'(route, matched, next) {
fetch('/api/users?id=12345')
.then(response => {
next('# Custom Markdown');
})
.catch(err => {
// Handle error...
});
},
},
};
```
Other than strings, route functions can return a falsy value (`null` \ `undefined`) to indicate that they ignore the current request:
```js
window.$docsify = {
routes: {
// accepts everything other than dogs (synchronous)
'/pets/(.+)'(route, matched) {
if (matched[0] === 'dogs') {
return null;
} else {
return 'I like all pets but dogs';
}
}
// accepts everything other than cats (asynchronous)
'/pets/(.*)'(route, matched, next) {
if (matched[0] === 'cats') {
next();
} else {
// Async task(s)...
next('I like all pets but cats');
}
}
}
}
```
Finally, if you have a specific path that has a real markdown file (and therefore should not be matched by your route), you can opt it out by returning an explicit `false` value:
```js
window.$docsify = {
routes: {
// if you look up /pets/cats, docsify will skip all routes and look for "pets/cats.md"
'/pets/cats'(route, matched) {
return false;
}
// but any other pet should generate dynamic content right here
'/pets/(.+)'(route, matched) {
const pet = matched[0];
return `your pet is ${pet} (but not a cat)`;
}
}
}
```
## skipLink
- Type: `Boolean|String|Object`
- Default: `'Skip to main content'`
Determines if/how the site's [skip navigation link](https://webaim.org/techniques/skipnav/) will be rendered.
```js
// Render skip link for all routes
window.$docsify = {
skipLink: 'Skip to content',
};
```
```js
// Render localized skip links based on route paths
window.$docsify = {
skipLink: {
'/es/': 'Saltar al contenido principal',
'/de-de/': 'Ga naar de hoofdinhoud',
'/ru-ru/': 'Перейти к основному содержанию',
'/zh-cn/': '跳到主要内容',
},
};
```
```js
// Do not render skip link
window.$docsify = {
skipLink: false,
};
```
```js
// Use default
window.$docsify = {
skipLink: true, // "Skip to main content"
};
```
## subMaxLevel
- Type: `Number`
- Default: `0`
Add table of contents (TOC) in custom sidebar.
```js
window.$docsify = {
subMaxLevel: 2,
};
```
If you have a link to the homepage in the sidebar and want it to be shown as active when accessing the root url, make sure to update your sidebar accordingly:
```markdown
- Sidebar
- [Home](/)
- [Another page](another.md)
```
For more details, see [#1131](https://github.com/docsifyjs/docsify/issues/1131).
## themeColor ⚠️ :id=themecolor
> [!IMPORTANT] Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color.
- Type: `String`
Customize the theme color.
```js
window.$docsify = {
themeColor: '#3F51B5',
};
```
## topMargin ⚠️ :id=topmargin
> [!IMPORTANT] Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes#theme-properties) to specify a scroll margin when using a sticky navbar.
- Type: `Number|String`
- Default: `0`
Adds scroll padding to the top of the viewport. This is useful when you have added a sticky or "fixed" element and would like auto scrolling to align with the bottom of your element.
```js
window.$docsify = {
topMargin: 90, // 90, '90px', '2rem', etc.
};
```
## vueComponents
- Type: `Object`
Creates and registers global [Vue](https://vuejs.org/guide/essentials/component-basics.html). Components are specified using the component name as the key with an object containing Vue options as the value. Component `data` is unique for each instance and will not persist as users navigate the site.
```js
window.$docsify = {
vueComponents: {
'button-counter': {
template: `
<button @click="count += 1">
You clicked me {{ count }} times
</button>
`,
data() {
return {
count: 0,
};
},
},
},
};
```
```markdown
<button-counter></button-counter>
```
<output data-lang="output">
<button-counter></button-counter>
</output>
## vueGlobalOptions
- Type: `Object`
Specifies global Vue options for use with Vue content not explicitly mounted with [vueMounts](#mounting-dom-elements), [vueComponents](#components), or a [markdown script](#markdown-script). Changes to global `data` will persist and be reflected anywhere global references are used.
```js
window.$docsify = {
vueGlobalOptions: {
data() {
return {
count: 0,
};
},
},
};
```
```markdown
<p>
<button @click="count -= 1">-</button>
{{ count }}
<button @click="count += 1">+</button>
</p>
```
<output data-lang="output">
<p>
<button @click="count -= 1">-</button>
{{ count }}
<button @click="count += 1">+</button>
</p>
</output>
## vueMounts
- Type: `Object`
Specifies DOM elements to mount as Vue instances and their associated options. Mount elements are specified using a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) as the key with an object containing Vue options as their value. Docsify will mount the first matching element in the main content area each time a new page is loaded. Mount element `data` is unique for each instance and will not persist as users navigate the site.
```js
window.$docsify = {
vueMounts: {
'#counter': {
data() {
return {
count: 0,
};
},
},
},
};
```
```markdown
<div id="counter">
<button @click="count -= 1">-</button>
{{ count }}
<button @click="count += 1">+</button>
</div>
```
<output id="counter">
<button @click="count -= 1">-</button>
{{ count }}
<button @click="count += 1">+</button>
</output>
================================================
FILE: docs/cover.md
================================================
# Cover
Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration#coverpage).
## Basic usage
Set `coverpage` to **true**, and create a `_coverpage.md`:
```js
window.$docsify = {
coverpage: true,
};
```
```markdown
<!-- _coverpage.md -->
# docsify
> A magical documentation site generator
- Simple and lightweight
- No statically built HTML files
- Multiple themes
[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#docsify)
```
## Customization
The cover page can be customized using [theme properties](themes#theme-properties):
<!-- prettier-ignore -->
```css
:root {
--cover-bg : url('path/to/image.png');
--cover-bg-overlay : rgba(0, 0, 0, 0.5);
--cover-color : #fff;
--cover-title-color: var(--theme-color);
--cover-title-font : 600 var(--font-size-xxxl) var(--font-family);
}
```
Alternatively, a background color or image can be specified in the cover page markdown.
```markdown
<!-- background color -->
```
```markdown
<!-- background image -->
```
## Coverpage as homepage
Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration#onlycover) option.
## Multiple covers
If your docs site is in more than one language, it may be useful to set multiple covers.
For example, your docs structure is like this
```text
.
└── docs
├── README.md
├── guide.md
├── _coverpage.md
└── zh-cn
├── README.md
└── guide.md
└── _coverpage.md
```
Now, you can set
```js
window.$docsify = {
coverpage: ['/', '/zh-cn/'],
};
```
Or a special file name
```js
window.$docsify = {
coverpage: {
'/': 'cover.md',
'/zh-cn/': 'cover.md',
},
};
```
================================================
FILE: docs/custom-navbar.md
================================================
# Custom navbar
## HTML
If you need custom navigation, you can create a HTML-based navigation bar.
> [!IMPORTANT] Note that documentation links begin with `#/`.
```html
<!-- index.html -->
<body>
<nav>
<a href="#/">EN</a>
<a href="#/zh-cn/">简体中文</a>
</nav>
<div id="app"></div>
</body>
```
## Markdown
Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [loadNavbar configuration](configuration#loadnavbar).
```html
<!-- index.html -->
<script>
window.$docsify = {
loadNavbar: true,
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
```
```markdown
<!-- _navbar.md -->
- [En](/)
- [chinese](/zh-cn/)
```
To create drop-down menus:
```markdown
<!-- _navbar.md -->
- Translations
- [En](/)
- [chinese](/zh-cn/)
```
> [!IMPORTANT] You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.
`_navbar.md` is loaded from each level directory. If the current directory doesn't have `_navbar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_navbar.md` will be loaded from `/guide/_navbar.md`.
## Nesting
You can create sub-lists by indenting items that are under a certain parent.
```markdown
<!-- _navbar.md -->
- Getting started
- [Quick start](quickstart.md)
- [Writing more pages](more-pages.md)
- [Custom navbar](custom-navbar.md)
- [Cover page](cover.md)
- Configuration
- [Configuration](configuration.md)
- [Themes](themes.md)
- [Using plugins](plugins.md)
- [Markdown configuration](markdown.md)
- [Language highlight](language-highlight.md)
```
renders as
## Combining custom navbars with the emoji plugin
If you use the [emoji plugin](plugins#emoji):
```html
<!-- index.html -->
<script>
window.$docsify = {
// ...
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/emoji.min.js"></script>
```
you could, for example, use flag emojis in your custom navbar Markdown file:
```markdown
<!-- _navbar.md -->
- [:us:, :uk:](/)
- [:cn:](/zh-cn/)
```
================================================
FILE: docs/deploy.md
================================================
# Deploy
Similar to [GitBook](https://www.gitbook.com), you can deploy files to GitHub Pages, GitLab Pages or VPS.
## GitHub Pages
There are three places to populate your docs for your GitHub repository:
- `docs/` folder
- main branch
- gh-pages branch
It is recommended that you save your files to the `./docs` subfolder of the `main` branch of your repository. Then select `main branch /docs folder` as your GitHub Pages source in your repository's settings page.
> [!IMPORTANT] You can also save files in the root directory and select `main branch`.
> You'll need to place a `.nojekyll` file in the deploy location (such as `/docs` or the gh-pages branch)
## GitLab Pages
If you are deploying your master branch, create a `.gitlab-ci.yml` with the following script:
> [!TIP] The `.public` workaround is so `cp` doesn't also copy `public/` to itself in an infinite loop.
```YAML
pages:
stage: deploy
script:
- mkdir .public
- cp -r * .public
- mv .public public
artifacts:
paths:
- public
only:
- master
```
> [!IMPORTANT] You can replace script with `- cp -r docs/. public`, if `./docs` is your Docsify subfolder.
## Firebase Hosting
> [!IMPORTANT] You'll need to install the Firebase CLI using `npm i -g firebase-tools` after signing into the [Firebase Console](https://console.firebase.google.com) using a Google Account.
Using a terminal, determine and navigate to the directory for your Firebase Project. This could be `~/Projects/Docs`, etc. From there, run `firebase init` and choose `Hosting` from the menu (use **space** to select, **arrow keys** to change options and **enter** to confirm). Follow the setup instructions.
Your `firebase.json` file should look similar to this (I changed the deployment directory from `public` to `site`):
```json
{
"hosting": {
"public": "site",
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"]
}
}
```
Once finished, build the starting template by running `docsify init ./site` (replacing site with the deployment directory you determined when running `firebase init` - public by default). Add/edit the documentation, then run `firebase deploy` from the root project directory.
## VPS
Use the following nginx config.
```nginx
server {
listen 80;
server_name your.domain.com;
location / {
alias /path/to/dir/of/docs/;
index index.html;
}
}
```
## Netlify
1. Login to your [Netlify](https://www.netlify.com/) account.
2. In the [dashboard](https://app.netlify.com/) page, click **Add New Site**.
3. Select GitHub.
4. Choose the repository where you store your docs, in the **Base Directory** add the subfolder where the files are stored. For example, it should be `docs`.
5. In the **Build Command** area leave it blank.
6. In the **Publish directory** area, if you have added the `docs` in the **Base Directory** you will see the publish directory populated with `docs/`
7. Netlify is smart enough to look for the the `index.html` file inside the `docs/` folder.
### HTML5 router
When using the HTML5 router, you need to set up redirect rules that redirect all requests to your `index.html`. It's pretty simple when you're using Netlify. Just create a file named `_redirects` in the docs directory, add this snippet to the file, and you're all set:
```sh
/* /index.html 200
```
## Vercel
1. Install [Vercel CLI](https://vercel.com/download), `npm i -g vercel`
2. Change directory to your docsify website, for example `cd docs`
3. Deploy with a single command, `vercel`
## AWS Amplify
1. Set the routerMode in the Docsify project `index.html` to _history_ mode.
```html
<script>
window.$docsify = {
loadSidebar: true,
routerMode: 'history',
};
</script>
```
2. Login to your [AWS Console](https://aws.amazon.com).
3. Go to the [AWS Amplify Dashboard](https://aws.amazon.com/amplify).
4. Choose the **Deploy** route to setup your project.
5. When prompted, keep the build settings empty if you're serving your docs within the root directory. If you're serving your docs from a different directory, customise your amplify.yml
```yml
version: 0.1
frontend:
phases:
build:
commands:
- echo "Nothing to build"
artifacts:
baseDirectory: /docs
files:
- '**/*'
cache:
paths: []
```
6. Add the following Redirect rules in their displayed order. Note that the second record is a PNG image where you can change it with any image format you are using.
| Source address | Target address | Type |
| -------------- | -------------- | ------------- |
| /<\*>.md | /<\*>.md | 200 (Rewrite) |
| /<\*>.png | /<\*>.png | 200 (Rewrite) |
| /<\*> | /index.html | 200 (Rewrite) |
## Stormkit
1. Login to your [Stormkit](https://www.stormkit.io) account.
2. Using the user interface, import your docsify project from one of the three supported Git providers (GitHub, GitLab, or Bitbucket).
3. Navigate to the project’s production environment in Stormkit or create a new environment if needed.
4. Verify the build command in your Stormkit configuration. By default, Stormkit CI will run `npm run build` but you can specify a custom build command on this page.
5. Set output folder to `docs`
6. Click the “Deploy Now” button to deploy your site.
Read more in the [Stormkit Documentation](https://stormkit.io/docs).
## Docker
- Create docsify files
You need prepare the initial files instead of making them inside the container.
See the [Quickstart](https://docsify.js.org/#/quickstart) section for instructions on how to create these files manually or using [docsify-cli](https://github.com/docsifyjs/docsify-cli).
```sh
index.html
README.md
```
- Create Dockerfile
```Dockerfile
FROM node:latest
LABEL description="A demo Dockerfile for build Docsify."
WORKDIR /docs
RUN npm install -g docsify-cli@latest
EXPOSE 3000/tcp
ENTRYPOINT docsify serve .
```
The current directory structure should be this:
```sh
index.html
README.md
Dockerfile
```
- Build docker image
```sh
docker build -f Dockerfile -t docsify/demo .
```
- Run docker image
```sh
docker run -itp 3000:3000 --name=docsify -v $(pwd):/docs docsify/demo
```
## Kinsta Static Site Hosting
You can deploy **Docsify** as a Static Site on [Kinsta](https://kinsta.com/static-site-hosting/).
1. Login or create an account to view your [MyKinsta](https://my.kinsta.com/) dashboard.
2. Authorize Kinsta with your Git provider.
3. Select **Static Sites** from the left sidebar and press **Add sites**.
4. Select the repository and branch you want to deploy.
5. During the build settings, Kinsta will automatically try to fill out the **Build command**, **Node version**, and **Publish directory**. If it won't, fill out the following:
- Build command: leave empty
- Node version: leave on default selection or a specific version (e.g. `18.16.0`)
- Publish directory: `docs`
6. Click the **Create site**.
## DeployHQ
[DeployHQ](https://www.deployhq.com/) is a deployment automation platform that deploys your code to SSH/SFTP servers, FTP servers, cloud storage (Amazon S3, Cloudflare R2), and modern hosting platforms (Netlify, Heroku).
> [!IMPORTANT] DeployHQ does not host your site. It automates deploying your Docsify files to your chosen hosting provider or server.
To deploy your Docsify site using DeployHQ:
1. Sign up for a [DeployHQ account](https://www.deployhq.com/) and verify your email.
2. Create your first project by clicking on **Projects** and **New Project**. Connect your Git repository (GitHub, GitLab, Bitbucket, or any private repository). Authorize DeployHQ to access your repository.
3. Add a server and enter your server details:
- Give your server a name
- Select your protocol (SSH/SFTP, FTP, or cloud platform)
- Enter your server hostname, username, and password/SSH key
- Set **Deployment Path** to your web root (e.g., `public_html/`)
4. Since Docsify doesn't require a build step, you can deploy your files directly. If your Docsify files are in a `docs/` folder, configure the **Source Path** in your server settings to `docs/`.
5. Click **Deploy Project**, then select your server and click **Deploy** to start your first deployment.
Your Docsify site will be deployed to your server. You can enable automatic deployments to deploy on every Git push, or schedule deployments for specific times.
For more information on advanced deployment features, see [DeployHQ's documentation](https://www.deployhq.com/support).
================================================
FILE: docs/embed-files.md
================================================
# Embed files
With docsify 4.6 it is now possible to embed any type of file.
You can embed these files as video, audio, iframes, or code blocks, and even Markdown files can even be embedded directly into the document.
For example, here is an embedded Markdown file. You only need to do this:
```markdown
[filename](_media/example.md ':include')
```
Then the content of `example.md` will be displayed directly here:
[filename](_media/example.md ':include')
You can check the original content for [example.md](_media/example.md ':ignore').
Normally, this will be compiled into a link, but in docsify, if you add `:include` it will be embedded. You can use single or double quotation marks around as you like.
External links can be used too - just replace the target. If you want to use a gist URL, see [Embed a gist](#embed-a-gist) section.
## Embedded file type
Currently, file extensions are automatically recognized and embedded in different ways.
These types are supported:
- **iframe** `.html`, `.htm`
- **markdown** `.markdown`, `.md`
- **audio** `.mp3`
- **video** `.mp4`, `.ogg`
- **code** other file extension
Of course, you can force the specified type. For example, a Markdown file can be embedded as a code block by setting `:type=code`.
```markdown
[filename](_media/example.md ':include :type=code')
```
You will get:
[filename](_media/example.md ':include :type=code')
## Markdown with YAML Front Matter
Front Matter, commonly utilized in blogging systems like Jekyll, serves to define metadata for a document. The [front-matter.js](https://www.npmjs.com/package/front-matter) package facilitates the extraction of metadata (front matter) from documents.
When using Markdown, YAML front matter will be stripped from the rendered content. The attributes cannot be used in this case.
```markdown
[filename](_media/example-with-yaml.md ':include')
```
You will get just the content
[filename](_media/example-with-yaml.md ':include')
## Embedded code fragments
Sometimes you don't want to embed a whole file. Maybe because you need just a few lines but you want to compile and test the file in CI.
```markdown
[filename](_media/example.js ':include :type=code :fragment=demo')
```
In your code file you need to surround the fragment between `/// [demo]` lines (before and after the fragment).
Alternatively you can use `### [demo]`. By default, only identifiers are omitted. To omit the entire line containing the identifier in the fragment output, add the `:omitFragmentLine` option. This is useful if your code fragment is e.g. HTML and you want to hide the Docsify fragment identifier from showing in your HTML source. `<!-- /// [demo] -->` in your source file and `:omitFragmentLine` will make the `-->` not show up in your Docsify code fragment section.
Example: In the source file \_media/example.js, `/// [demo]` identifiers have been included:
```markdown
[filename](_media/example.js ':include :type=code')
```
[filename](_media/example.js ':include :type=code')
Adding the `:fragment=demo` results in the following:
```markdown
[filename](_media/example.js ':include :type=code :fragment=demo')
```
[filename](_media/example.js ':include :type=code :fragment=demo')
## Tag attribute
If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
> [!TIP] Note, for the `audio` and `video` types, docsify adds the `controls` attribute by default. When you want add more attributes, the `controls` attribute need to be added manually if need be.
```md
[filename](_media/example.mp4 ':include :type=video controls width=100%')
```
```markdown
[cinwell website](https://cinwell.com ':include :type=iframe width=100% height=400px')
```
[cinwell website](https://cinwell.com ':include :type=iframe width=100% height=400px')
Did you see it? You only need to write directly. You can check [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) for these attributes.
## The code block highlight
Embedding any type of source code file, you can specify the highlighted language or automatically identify.
```markdown
[](_media/example.html ':include :type=code text')
```
⬇️
[](_media/example.html ':include :type=code text')
> [!TIP] How to set highlight? You can see [here](language-highlight.md).
## Embed a gist
You can embed a gist as markdown content or as a code block - this is based on the approach at the start of [Embed Files](#embed-files) section, but uses a raw gist URL as the target.
> [!TIP] **No** plugin or app config change is needed here to make this work. In fact, the "Embed" `script` tag that is copied from a gist will _not_ load even if you make plugin or config changes to allow an external script.
### Identify the gist's metadata
Start by viewing a gist on `gist.github.com`. For the purposes of this guide, we use this gist:
- https://gist.github.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15
Identify the following items from the gist:
| Field | Example | Description |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------- |
| **Username** | `anikethsaha` | The gist's owner. |
| **Gist ID** | `c2bece08f27c4277001f123898d16a7c` | Identifier for the gist. This is fixed for the gist's lifetime. |
| **Filename** | `content.md` | Select a name of a file in the gist. This needed even on a single-file gist for embedding to work. |
You will need those to build the _raw gist URL_ for the target file. This has the following format:
- `https://gist.githubusercontent.com/USERNAME/GIST_ID/raw/FILENAME`
Here are two examples based on the sample gist:
- https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/content.md
- https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js
> [!TIP] Alternatively, you can get a raw URL directly clicking the _Raw_ button on a gist file. But, if you use that approach, just be sure to **remove** the revision number between `raw/` and the filename so that the URL matches the pattern above instead. Otherwise your embedded gist will **not** show the latest content when the gist is updated.
Continue with one of the sections below to embed the gist on a Docsify page.
### Render markdown content from a gist
This is a great way to embed content **seamlessly** in your docs, without sending someone to an external link. This approach is well-suited to reusing a gist of say installation instructions across doc sites of multiple repos. This approach works equally well with a gist owned by your account or by another user.
Here is the format:
```markdown
[LABEL](https://gist.githubusercontent.com/USERNAME/GIST_ID/raw/FILENAME ':include')
```
For example:
```markdown
[gist: content.md](https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/content.md ':include')
```
Which renders as:
[gist: content.md](https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/content.md ':include')
The `LABEL` can be any text you want. It acts as a _fallback_ message if the link is broken - so it is useful to repeat the filename here in case you need to fix a broken link. It also makes an embedded element easy to read at a glance.
### Render a codeblock from a gist
The format is the same as the previous section, but with `:type=code` added to the alt text. As with the [Embedded file type](#embedded-file-type) section, the syntax highlighting will be **inferred** from the extension (e.g. `.js` or `.py`), so you can leave the `type` set as `code`.
Here is the format:
```markdown
[LABEL](https://gist.githubusercontent.com/USERNAME/GIST_ID/raw/FILENAME ':include :type=code')
```
For example:
```markdown
[gist: script.js](https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js ':include :type=code')
```
Which renders as:
[gist: script.js](https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js ':include :type=code')
================================================
FILE: docs/emoji.md
================================================
# Emoji
Below is a complete list of emoji shorthand codes. Docsify can be configured to render emoji using GitHub-style emoji images or native emoji characters using the [`nativeEmoji`](configuration#nativeemoji) configuration option.
<div style="display: grid; grid-template-columns: repeat(auto-fill, minmax(15em, 1fr));">
<!-- START: Auto-generated content (/build/emoji.js) -->
:100: `:100:`
:1234: `:1234:`
:+1: `:+1:`
:-1: `:-1:`
:1st_place_medal: `:1st_place_medal:`
:2nd_place_medal: `:2nd_place_medal:`
:3rd_place_medal: `:3rd_place_medal:`
:8ball: `:8ball:`
:a: `:a:`
:ab: `:ab:`
:abacus: `:abacus:`
:abc: `:abc:`
:abcd: `:abcd:`
:accept: `:accept:`
:accessibility: `:accessibility:`
:accordion: `:accordion:`
:adhesive_bandage: `:adhesive_bandage:`
:adult: `:adult:`
:aerial_tramway: `:aerial_tramway:`
:afghanistan: `:afghanistan:`
:airplane: `:airplane:`
:aland_islands: `:aland_islands:`
:alarm_clock: `:alarm_clock:`
:albania: `:albania:`
:alembic: `:alembic:`
:algeria: `:algeria:`
:alien: `:alien:`
:ambulance: `:ambulance:`
:american_samoa: `:american_samoa:`
:amphora: `:amphora:`
:anatomical_heart: `:anatomical_heart:`
:anchor: `:anchor:`
:andorra: `:andorra:`
:angel: `:angel:`
:anger: `:anger:`
:angola: `:angola:`
:angry: `:angry:`
:anguilla: `:anguilla:`
:anguished: `:anguished:`
:ant: `:ant:`
:antarctica: `:antarctica:`
:antigua_barbuda: `:antigua_barbuda:`
:apple: `:apple:`
:aquarius: `:aquarius:`
:argentina: `:argentina:`
:aries: `:aries:`
:armenia: `:armenia:`
:arrow_backward: `:arrow_backward:`
:arrow_double_down: `:arrow_double_down:`
:arrow_double_up: `:arrow_double_up:`
:arrow_down: `:arrow_down:`
:arrow_down_small: `:arrow_down_small:`
:arrow_forward: `:arrow_forward:`
:arrow_heading_down: `:arrow_heading_down:`
:arrow_heading_up: `:arrow_heading_up:`
:arrow_left: `:arrow_left:`
:arrow_lower_left: `:arrow_lower_left:`
:arrow_lower_right: `:arrow_lower_right:`
:arrow_right: `:arrow_right:`
:arrow_right_hook: `:arrow_right_hook:`
:arrow_up: `:arrow_up:`
:arrow_up_down: `:arrow_up_down:`
:arrow_up_small: `:arrow_up_small:`
:arrow_upper_left: `:arrow_upper_left:`
:arrow_upper_right: `:arrow_upper_right:`
:arrows_clockwise: `:arrows_clockwise:`
:arrows_counterclockwise: `:arrows_counterclockwise:`
:art: `:art:`
:articulated_lorry: `:articulated_lorry:`
:artificial_satellite: `:artificial_satellite:`
:artist: `:artist:`
:aruba: `:aruba:`
:ascension_island: `:ascension_island:`
:asterisk: `:asterisk:`
:astonished: `:astonished:`
:astronaut: `:astronaut:`
:athletic_shoe: `:athletic_shoe:`
:atm: `:atm:`
:atom: `:atom:`
:atom_symbol: `:atom_symbol:`
:australia: `:australia:`
:austria: `:austria:`
:auto_rickshaw: `:auto_rickshaw:`
:avocado: `:avocado:`
:axe: `:axe:`
:azerbaijan: `:azerbaijan:`
:b: `:b:`
:baby: `:baby:`
:baby_bottle: `:baby_bottle:`
:baby_chick: `:baby_chick:`
:baby_symbol: `:baby_symbol:`
:back: `:back:`
:bacon: `:bacon:`
:badger: `:badger:`
:badminton: `:badminton:`
:bagel: `:bagel:`
:baggage_claim: `:baggage_claim:`
:baguette_bread: `:baguette_bread:`
:bahamas: `:bahamas:`
:bahrain: `:bahrain:`
:balance_scale: `:balance_scale:`
:bald_man: `:bald_man:`
:bald_woman: `:bald_woman:`
:ballet_shoes: `:ballet_shoes:`
:balloon: `:balloon:`
:ballot_box: `:ballot_box:`
:ballot_box_with_check: `:ballot_box_with_check:`
:bamboo: `:bamboo:`
:banana: `:banana:`
:bangbang: `:bangbang:`
:bangladesh: `:bangladesh:`
:banjo: `:banjo:`
:bank: `:bank:`
:bar_chart: `:bar_chart:`
:barbados: `:barbados:`
:barber: `:barber:`
:baseball: `:baseball:`
:basecamp: `:basecamp:`
:basecampy: `:basecampy:`
:basket: `:basket:`
:basketball: `:basketball:`
:basketball_man: `:basketball_man:`
:basketball_woman: `:basketball_woman:`
:bat: `:bat:`
:bath: `:bath:`
:bathtub: `:bathtub:`
:battery: `:battery:`
:beach_umbrella: `:beach_umbrella:`
:beans: `:beans:`
:bear: `:bear:`
:bearded_person: `:bearded_person:`
:beaver: `:beaver:`
:bed: `:bed:`
:bee: `:bee:`
:beer: `:beer:`
:beers: `:beers:`
:beetle: `:beetle:`
:beginner: `:beginner:`
:belarus: `:belarus:`
:belgium: `:belgium:`
:belize: `:belize:`
:bell: `:bell:`
:bell_pepper: `:bell_pepper:`
:bellhop_bell: `:bellhop_bell:`
:benin: `:benin:`
:bento: `:bento:`
:bermuda: `:bermuda:`
:beverage_box: `:beverage_box:`
:bhutan: `:bhutan:`
:bicyclist: `:bicyclist:`
:bike: `:bike:`
:biking_man: `:biking_man:`
:biking_woman: `:biking_woman:`
:bikini: `:bikini:`
:billed_cap: `:billed_cap:`
:biohazard: `:biohazard:`
:bird: `:bird:`
:birthday: `:birthday:`
:bison: `:bison:`
:biting_lip: `:biting_lip:`
:black_bird: `:black_bird:`
:black_cat: `:black_cat:`
:black_circle: `:black_circle:`
:black_flag: `:black_flag:`
:black_heart: `:black_heart:`
:black_joker: `:black_joker:`
:black_large_square: `:black_large_square:`
:black_medium_small_square: `:black_medium_small_square:`
:black_medium_square: `:black_medium_square:`
:black_nib: `:black_nib:`
:black_small_square: `:black_small_square:`
:black_square_button: `:black_square_button:`
:blond_haired_man: `:blond_haired_man:`
:blond_haired_person: `:blond_haired_person:`
:blond_haired_woman: `:blond_haired_woman:`
:blonde_woman: `:blonde_woman:`
:blossom: `:blossom:`
:blowfish: `:blowfish:`
:blue_book: `:blue_book:`
:blue_car: `:blue_car:`
:blue_heart: `:blue_heart:`
:blue_square: `:blue_square:`
:blueberries: `:blueberries:`
:blush: `:blush:`
:boar: `:boar:`
:boat: `:boat:`
:bolivia: `:bolivia:`
:bomb: `:bomb:`
:bone: `:bone:`
:book: `:book:`
:bookmark: `:bookmark:`
:bookmark_tabs: `:bookmark_tabs:`
:books: `:books:`
:boom: `:boom:`
:boomerang: `:boomerang:`
:boot: `:boot:`
:bosnia_herzegovina: `:bosnia_herzegovina:`
:botswana: `:botswana:`
:bouncing_ball_man: `:bouncing_ball_man:`
:bouncing_ball_person: `:bouncing_ball_person:`
:bouncing_ball_woman: `:bouncing_ball_woman:`
:bouquet: `:bouquet:`
:bouvet_island: `:bouvet_island:`
:bow: `:bow:`
:bow_and_arrow: `:bow_and_arrow:`
:bowing_man: `:bowing_man:`
:bowing_woman: `:bowing_woman:`
:bowl_with_spoon: `:bowl_with_spoon:`
:bowling: `:bowling:`
:bowtie: `:bowtie:`
:boxing_glove: `:boxing_glove:`
:boy: `:boy:`
:brain: `:brain:`
:brazil: `:brazil:`
:bread: `:bread:`
:breast_feeding: `:breast_feeding:`
:bricks: `:bricks:`
:bride_with_veil: `:bride_with_veil:`
:bridge_at_night: `:bridge_at_night:`
:briefcase: `:briefcase:`
:british_indian_ocean_territory: `:british_indian_ocean_territory:`
:british_virgin_islands: `:british_virgin_islands:`
:broccoli: `:broccoli:`
:broken_heart: `:broken_heart:`
:broom: `:broom:`
:brown_circle: `:brown_circle:`
:brown_heart: `:brown_heart:`
:brown_square: `:brown_square:`
:brunei: `:brunei:`
:bubble_tea: `:bubble_tea:`
:bubbles: `:bubbles:`
:bucket: `:bucket:`
:bug: `:bug:`
:building_construction: `:building_construction:`
:bulb: `:bulb:`
:bulgaria: `:bulgaria:`
:bullettrain_front: `:bullettrain_front:`
:bullettrain_side: `:bullettrain_side:`
:burkina_faso: `:burkina_faso:`
:burrito: `:burrito:`
:burundi: `:burundi:`
:bus: `:bus:`
:business_suit_levitating: `:business_suit_levitating:`
:busstop: `:busstop:`
:bust_in_silhouette: `:bust_in_silhouette:`
:busts_in_silhouette: `:busts_in_silhouette:`
:butter: `:butter:`
:butterfly: `:butterfly:`
:cactus: `:cactus:`
:cake: `:cake:`
:calendar: `:calendar:`
:call_me_hand: `:call_me_hand:`
:calling: `:calling:`
:cambodia: `:cambodia:`
:camel: `:camel:`
:camera: `:camera:`
:camera_flash: `:camera_flash:`
:cameroon: `:cameroon:`
:camping: `:camping:`
:canada: `:canada:`
:canary_islands: `:canary_islands:`
:cancer: `:cancer:`
:candle: `:candle:`
:candy: `:candy:`
:canned_food: `:canned_food:`
:canoe: `:canoe:`
:cape_verde: `:cape_verde:`
:capital_abcd: `:capital_abcd:`
:capricorn: `:capricorn:`
:car: `:car:`
:card_file_box: `:card_file_box:`
:card_index: `:card_index:`
:card_index_dividers: `:card_index_dividers:`
:caribbean_netherlands: `:caribbean_netherlands:`
:carousel_horse: `:carousel_horse:`
:carpentry_saw: `:carpentry_saw:`
:carrot: `:carrot:`
:cartwheeling: `:cartwheeling:`
:cat: `:cat:`
:cat2: `:cat2:`
:cayman_islands: `:cayman_islands:`
:cd: `:cd:`
:central_african_republic: `:central_african_republic:`
:ceuta_melilla: `:ceuta_melilla:`
:chad: `:chad:`
:chains: `:chains:`
:chair: `:chair:`
:champagne: `:champagne:`
:chart: `:chart:`
:chart_with_downwards_trend: `:chart_with_downwards_trend:`
:chart_with_upwards_trend: `:chart_with_upwards_trend:`
:checkered_flag: `:checkered_flag:`
:cheese: `:cheese:`
:cherries: `:cherries:`
:cherry_blossom: `:cherry_blossom:`
:chess_pawn: `:chess_pawn:`
:chestnut: `:chestnut:`
:chicken: `:chicken:`
:child: `:child:`
:children_crossing: `:children_crossing:`
:chile: `:chile:`
:chipmunk: `:chipmunk:`
:chocolate_bar: `:chocolate_bar:`
:chopsticks: `:chopsticks:`
:christmas_island: `:christmas_island:`
:christmas_tree: `:christmas_tree:`
:church: `:church:`
:cinema: `:cinema:`
:circus_tent: `:circus_tent:`
:city_sunrise: `:city_sunrise:`
:city_sunset: `:city_sunset:`
:cityscape: `:cityscape:`
:cl: `:cl:`
:clamp: `:clamp:`
:clap: `:clap:`
:clapper: `:clapper:`
:classical_building: `:classical_building:`
:climbing: `:climbing:`
:climbing_man: `:climbing_man:`
:climbing_woman: `:climbing_woman:`
:clinking_glasses: `:clinking_glasses:`
:clipboard: `:clipboard:`
:clipperton_island: `:clipperton_island:`
:clock1: `:clock1:`
:clock10: `:clock10:`
:clock1030: `:clock1030:`
:clock11: `:clock11:`
:clock1130: `:clock1130:`
:clock12: `:clock12:`
:clock1230: `:clock1230:`
:clock130: `:clock130:`
:clock2: `:clock2:`
:clock230: `:clock230:`
:clock3: `:clock3:`
:clock330: `:clock330:`
:clock4: `:clock4:`
:clock430: `:clock430:`
:clock5: `:clock5:`
:clock530: `:clock530:`
:clock6: `:clock6:`
:clock630: `:clock630:`
:clock7: `:clock7:`
:clock730: `:clock730:`
:clock8: `:clock8:`
:clock830: `:clock830:`
:clock9: `:clock9:`
:clock930: `:clock930:`
:closed_book: `:closed_book:`
:closed_lock_with_key: `:closed_lock_with_key:`
:closed_umbrella: `:closed_umbrella:`
:cloud: `:cloud:`
:cloud_with_lightning: `:cloud_with_lightning:`
:cloud_with_lightning_and_rain: `:cloud_with_lightning_and_rain:`
:cloud_with_rain: `:cloud_with_rain:`
:cloud_with_snow: `:cloud_with_snow:`
:clown_face: `:clown_face:`
:clubs: `:clubs:`
:cn: `:cn:`
:coat: `:coat:`
:cockroach: `:cockroach:`
:cocktail: `:cocktail:`
:coconut: `:coconut:`
:cocos_islands: `:cocos_islands:`
:coffee: `:coffee:`
:coffin: `:coffin:`
:coin: `:coin:`
:cold_face: `:cold_face:`
:cold_sweat: `:cold_sweat:`
:collision: `:collision:`
:colombia: `:colombia:`
:comet: `:comet:`
:comoros: `:comoros:`
:compass: `:compass:`
:computer: `:computer:`
:computer_mouse: `:computer_mouse:`
:confetti_ball: `:confetti_ball:`
:confounded: `:confounded:`
:confused: `:confused:`
:congo_brazzaville: `:congo_brazzaville:`
:congo_kinshasa: `:congo_kinshasa:`
:congratulations: `:congratulations:`
:construction: `:construction:`
:construction_worker: `:construction_worker:`
:construction_worker_man: `:construction_worker_man:`
:construction_worker_woman: `:construction_worker_woman:`
:control_knobs: `:control_knobs:`
:convenience_store: `:convenience_store:`
:cook: `:cook:`
:cook_islands: `:cook_islands:`
:cookie: `:cookie:`
:cool: `:cool:`
:cop: `:cop:`
:copilot: `:copilot:`
:copyright: `:copyright:`
:coral: `:coral:`
:corn: `:corn:`
:costa_rica: `:costa_rica:`
:cote_divoire: `:cote_divoire:`
:couch_and_lamp: `:couch_and_lamp:`
:couple: `:couple:`
:couple_with_heart: `:couple_with_heart:`
:couple_with_heart_man_man: `:couple_with_heart_man_man:`
:couple_with_heart_woman_man: `:couple_with_heart_woman_man:`
:couple_with_heart_woman_woman: `:couple_with_heart_woman_woman:`
:couplekiss: `:couplekiss:`
:couplekiss_man_man: `:couplekiss_man_man:`
:couplekiss_man_woman: `:couplekiss_man_woman:`
:couplekiss_woman_woman: `:couplekiss_woman_woman:`
:cow: `:cow:`
:cow2: `:cow2:`
:cowboy_hat_face: `:cowboy_hat_face:`
:crab: `:crab:`
:crayon: `:crayon:`
:credit_card: `:credit_card:`
:crescent_moon: `:crescent_moon:`
:cricket: `:cricket:`
:cricket_game: `:cricket_game:`
:croatia: `:croatia:`
:crocodile: `:crocodile:`
:croissant: `:croissant:`
:crossed_fingers: `:crossed_fingers:`
:crossed_flags: `:crossed_flags:`
:crossed_swords: `:crossed_swords:`
:crown: `:crown:`
:crutch: `:crutch:`
:cry: `:cry:`
:crying_cat_face: `:crying_cat_face:`
:crystal_ball: `:crystal_ball:`
:cuba: `:cuba:`
:cucumber: `:cucumber:`
:cup_with_straw: `:cup_with_straw:`
:cupcake: `:cupcake:`
:cupid: `:cupid:`
:curacao: `:curacao:`
:curling_stone: `:curling_stone:`
:curly_haired_man: `:curly_haired_man:`
:curly_haired_woman: `:curly_haired_woman:`
:curly_loop: `:curly_loop:`
:currency_exchange: `:currency_exchange:`
:curry: `:curry:`
:cursing_face: `:cursing_face:`
:custard: `:custard:`
:customs: `:customs:`
:cut_of_meat: `:cut_of_meat:`
:cyclone: `:cyclone:`
:cyprus: `:cyprus:`
:czech_republic: `:czech_republic:`
:dagger: `:dagger:`
:dancer: `:dancer:`
:dancers: `:dancers:`
:dancing_men: `:dancing_men:`
:dancing_women: `:dancing_women:`
:dango: `:dango:`
:dark_sunglasses: `:dark_sunglasses:`
:dart: `:dart:`
:dash: `:dash:`
:date: `:date:`
:de: `:de:`
:deaf_man: `:deaf_man:`
:deaf_person: `:deaf_person:`
:deaf_woman: `:deaf_woman:`
:deciduous_tree: `:deciduous_tree:`
:deer: `:deer:`
:denmark: `:denmark:`
:department_store: `:department_store:`
:dependabot: `:dependabot:`
:derelict_house: `:derelict_house:`
:desert: `:desert:`
:desert_island: `:desert_island:`
:desktop_computer: `:desktop_computer:`
:detective: `:detective:`
:diamond_shape_with_a_dot_inside: `:diamond_shape_with_a_dot_inside:`
:diamonds: `:diamonds:`
:diego_garcia: `:diego_garcia:`
:disappointed: `:disappointed:`
:disappointed_relieved: `:disappointed_relieved:`
:disguised_face: `:disguised_face:`
:diving_mask: `:diving_mask:`
:diya_lamp: `:diya_lamp:`
:dizzy: `:dizzy:`
:dizzy_face: `:dizzy_face:`
:djibouti: `:djibouti:`
:dna: `:dna:`
:do_not_litter: `:do_not_litter:`
:dodo: `:dodo:`
:dog: `:dog:`
:dog2: `:dog2:`
:dollar: `:dollar:`
:dolls: `:dolls:`
:dolphin: `:dolphin:`
:dominica: `:dominica:`
:dominican_republic: `:dominican_republic:`
:donkey: `:donkey:`
:door: `:door:`
:dotted_line_face: `:dotted_line_face:`
:doughnut: `:doughnut:`
:dove: `:dove:`
:dragon: `:dragon:`
:dragon_face: `:dragon_face:`
:dress: `:dress:`
:dromedary_camel: `:dromedary_camel:`
:drooling_face: `:drooling_face:`
:drop_of_blood: `:drop_of_blood:`
:droplet: `:droplet:`
:drum: `:drum:`
:duck: `:duck:`
:dumpling: `:dumpling:`
:dvd: `:dvd:`
:e-mail: `:e-mail:`
:eagle: `:eagle:`
:ear: `:ear:`
:ear_of_rice: `:ear_of_rice:`
:ear_with_hearing_aid: `:ear_with_hearing_aid:`
:earth_africa: `:earth_africa:`
:earth_americas: `:earth_americas:`
:earth_asia: `:earth_asia:`
:ecuador: `:ecuador:`
:egg: `:egg:`
:eggplant: `:eggplant:`
:egypt: `:egypt:`
:eight: `:eight:`
:eight_pointed_black_star: `:eight_pointed_black_star:`
:eight_spoked_asterisk: `:eight_spoked_asterisk:`
:eject_button: `:eject_button:`
:el_salvador: `:el_salvador:`
:electric_plug: `:electric_plug:`
:electron: `:electron:`
:elephant: `:elephant:`
:elevator: `:elevator:`
:elf: `:elf:`
:elf_man: `:elf_man:`
:elf_woman: `:elf_woman:`
:email: `:email:`
:empty_nest: `:empty_nest:`
:end: `:end:`
:england: `:england:`
:envelope: `:envelope:`
:envelope_with_arrow: `:envelope_with_arrow:`
:equatorial_guinea: `:equatorial_guinea:`
:eritrea: `:eritrea:`
:es: `:es:`
:estonia: `:estonia:`
:ethiopia: `:ethiopia:`
:eu: `:eu:`
:euro: `:euro:`
:european_castle: `:european_castle:`
:european_post_office: `:european_post_office:`
:european_union: `:european_union:`
:evergreen_tree: `:evergreen_tree:`
:exclamation: `:exclamation:`
:exploding_head: `:exploding_head:`
:expressionless: `:expressionless:`
:eye: `:eye:`
:eye_speech_bubble: `:eye_speech_bubble:`
:eyeglasses: `:eyeglasses:`
:eyes: `:eyes:`
:face_exhaling: `:face_exhaling:`
:face_holding_back_tears: `:face_holding_back_tears:`
:face_in_clouds: `:face_in_clouds:`
:face_with_diagonal_mouth: `:face_with_diagonal_mouth:`
:face_with_head_bandage: `:face_with_head_bandage:`
:face_with_open_eyes_and_hand_over_mouth: `:face_with_open_eyes_and_hand_over_mouth:`
:face_with_peeking_eye: `:face_with_peeking_eye:`
:face_with_spiral_eyes: `:face_with_spiral_eyes:`
:face_with_thermometer: `:face_with_thermometer:`
:facepalm: `:facepalm:`
:facepunch: `:facepunch:`
:factory: `:factory:`
:factory_worker: `:factory_worker:`
:fairy: `:fairy:`
:fairy_man: `:fairy_man:`
:fairy_woman: `:fairy_woman:`
:falafel: `:falafel:`
:falkland_islands: `:falkland_islands:`
:fallen_leaf: `:fallen_leaf:`
:family: `:family:`
:family_man_boy: `:family_man_boy:`
:family_man_boy_boy: `:family_man_boy_boy:`
:family_man_girl: `:family_man_girl:`
:family_man_girl_boy: `:family_man_girl_boy:`
:family_man_girl_girl: `:family_man_girl_girl:`
:family_man_man_boy: `:family_man_man_boy:`
:family_man_man_boy_boy: `:family_man_man_boy_boy:`
:family_man_man_girl: `:family_man_man_girl:`
:family_man_man_girl_boy: `:family_man_man_girl_boy:`
:family_man_man_girl_girl: `:family_man_man_girl_girl:`
:family_man_woman_boy: `:family_man_woman_boy:`
:family_man_woman_boy_boy: `:family_man_woman_boy_boy:`
:family_man_woman_girl: `:family_man_woman_girl:`
:family_man_woman_girl_boy: `:family_man_woman_girl_boy:`
:family_man_woman_girl_girl: `:family_man_woman_girl_girl:`
:family_woman_boy: `:family_woman_boy:`
:family_woman_boy_boy: `:family_woman_boy_boy:`
:family_woman_girl: `:family_woman_girl:`
:family_woman_girl_boy: `:family_woman_girl_boy:`
:family_woman_girl_girl: `:family_woman_girl_girl:`
:family_woman_woman_boy: `:family_woman_woman_boy:`
:family_woman_woman_boy_boy: `:family_woman_woman_boy_boy:`
:family_woman_woman_girl: `:family_woman_woman_girl:`
:family_woman_woman_girl_boy: `:family_woman_woman_girl_boy:`
:family_woman_woman_girl_girl: `:family_woman_woman_girl_girl:`
:farmer: `:farmer:`
:faroe_islands: `:faroe_islands:`
:fast_forward: `:fast_forward:`
:fax: `:fax:`
:fearful: `:fearful:`
:feather: `:feather:`
:feelsgood: `:feelsgood:`
:feet: `:feet:`
:female_detective: `:female_detective:`
:female_sign: `:female_sign:`
:ferris_wheel: `:ferris_wheel:`
:ferry: `:ferry:`
:field_hockey: `:field_hockey:`
:fiji: `:fiji:`
:file_cabinet: `:file_cabinet:`
:file_folder: `:file_folder:`
:film_projector: `:film_projector:`
:film_strip: `:film_strip:`
:finland: `:finland:`
:finnadie: `:finnadie:`
:fire: `:fire:`
:fire_engine: `:fire_engine:`
:fire_extinguisher: `:fire_extinguisher:`
:firecracker: `:firecracker:`
:firefighter: `:firefighter:`
:fireworks: `:fireworks:`
:first_quarter_moon: `:first_quarter_moon:`
:first_quarter_moon_with_face: `:first_quarter_moon_with_face:`
:fish: `:fish:`
:fish_cake: `:fish_cake:`
:fishing_pole_and_fish: `:fishing_pole_and_fish:`
:fishsticks: `:fishsticks:`
:fist: `:fist:`
:fist_left: `:fist_left:`
:fist_oncoming: `:fist_oncoming:`
:fist_raised: `:fist_raised:`
:fist_right: `:fist_right:`
:five: `:five:`
:flags: `:flags:`
:flamingo: `:flamingo:`
:flashlight: `:flashlight:`
:flat_shoe: `:flat_shoe:`
:flatbread: `:flatbread:`
:fleur_de_lis: `:fleur_de_lis:`
:flight_arrival: `:flight_arrival:`
:flight_departure: `:flight_departure:`
:flipper: `:flipper:`
:floppy_disk: `:floppy_disk:`
:flower_playing_cards: `:flower_playing_cards:`
:flushed: `:flushed:`
:flute: `:flute:`
:fly: `:fly:`
:flying_disc: `:flying_disc:`
:flying_saucer: `:flying_saucer:`
:fog: `:fog:`
:foggy: `:foggy:`
:folding_hand_fan: `:folding_hand_fan:`
:fondue: `:fondue:`
:foot: `:foot:`
:football: `:football:`
:footprints: `:footprints:`
:fork_and_knife: `:fork_and_knife:`
:fortune_cookie: `:fortune_cookie:`
:fountain: `:fountain:`
:fountain_pen: `:fountain_pen:`
:four: `:four:`
:four_leaf_clover: `:four_leaf_clover:`
:fox_face: `:fox_face:`
:fr: `:fr:`
:framed_picture: `:framed_picture:`
:free: `:free:`
:french_guiana: `:french_guiana:`
:french_polynesia: `:french_polynesia:`
:french_southern_territories: `:french_southern_territories:`
:fried_egg: `:fried_egg:`
:fried_shrimp: `:fried_shrimp:`
:fries: `:fries:`
:frog: `:frog:`
:frowning: `:frowning:`
:frowning_face: `:frowning_face:`
:frowning_man: `:frowning_man:`
:frowning_person: `:frowning_person:`
:frowning_woman: `:frowning_woman:`
:fu: `:fu:`
:fuelpump: `:fuelpump:`
:full_moon: `:full_moon:`
:full_moon_with_face: `:full_moon_with_face:`
:funeral_urn: `:funeral_urn:`
:gabon: `:gabon:`
:gambia: `:gambia:`
:game_die: `:game_die:`
:garlic: `:garlic:`
:gb: `:gb:`
:gear: `:gear:`
:gem: `:gem:`
:gemini: `:gemini:`
:genie: `:genie:`
:genie_man: `:genie_man:`
:genie_woman: `:genie_woman:`
:georgia: `:georgia:`
:ghana: `:ghana:`
:ghost: `:ghost:`
:gibraltar: `:gibraltar:`
:gift: `:gift:`
:gift_heart: `:gift_heart:`
:ginger_root: `:ginger_root:`
:giraffe: `:giraffe:`
:girl: `:girl:`
:globe_with_meridians: `:globe_with_meridians:`
:gloves: `:gloves:`
:goal_net: `:goal_net:`
:goat: `:goat:`
:goberserk: `:goberserk:`
:godmode: `:godmode:`
:goggles: `:goggles:`
:golf: `:golf:`
:golfing: `:golfing:`
:golfing_man: `:golfing_man:`
:golfing_woman: `:golfing_woman:`
:goose: `:goose:`
:gorilla: `:gorilla:`
:grapes: `:grapes:`
:greece: `:greece:`
:green_apple: `:green_apple:`
:green_book: `:green_book:`
:green_circle: `:green_circle:`
:green_heart: `:green_heart:`
:green_salad: `:green_salad:`
:green_square: `:green_square:`
:greenland: `:greenland:`
:grenada: `:grenada:`
:grey_exclamation: `:grey_exclamation:`
:grey_heart: `:grey_heart:`
:grey_question: `:grey_question:`
:grimacing: `:grimacing:`
:grin: `:grin:`
:grinning: `:grinning:`
:guadeloupe: `:guadeloupe:`
:guam: `:guam:`
:guard: `:guard:`
:guardsman: `:guardsman:`
:guardswoman: `:guardswoman:`
:guatemala: `:guatemala:`
:guernsey: `:guernsey:`
:guide_dog: `:guide_dog:`
:guinea: `:guinea:`
:guinea_bissau: `:guinea_bissau:`
:guitar: `:guitar:`
:gun: `:gun:`
:guyana: `:guyana:`
:hair_pick: `:hair_pick:`
:haircut: `:haircut:`
:haircut_man: `:haircut_man:`
:haircut_woman: `:haircut_woman:`
:haiti: `:haiti:`
:hamburger: `:hamburger:`
:hammer: `:hammer:`
:hammer_and_pick: `:hammer_and_pick:`
:hammer_and_wrench: `:hammer_and_wrench:`
:hamsa: `:hamsa:`
:hamster: `:hamster:`
:hand: `:hand:`
:hand_over_mouth: `:hand_over_mouth:`
:hand_with_index_finger_and_thumb_crossed: `:hand_with_index_finger_and_thumb_crossed:`
:handbag: `:handbag:`
:handball_person: `:handball_person:`
:handshake: `:handshake:`
:hankey: `:hankey:`
:hash: `:hash:`
:hatched_chick: `:hatched_chick:`
:hatching_chick: `:hatching_chick:`
:headphones: `:headphones:`
:headstone: `:headstone:`
:health_worker: `:health_worker:`
:hear_no_evil: `:hear_no_evil:`
:heard_mcdonald_islands: `:heard_mcdonald_islands:`
:heart: `:heart:`
:heart_decoration: `:heart_decoration:`
:heart_eyes: `:heart_eyes:`
:heart_eyes_cat: `:heart_eyes_cat:`
:heart_hands: `:heart_hands:`
:heart_on_fire: `:heart_on_fire:`
:heartbeat: `:heartbeat:`
:heartpulse: `:heartpulse:`
:hearts: `:hearts:`
:heavy_check_mark: `:heavy_check_mark:`
:heavy_division_sign: `:heavy_division_sign:`
:heavy_dollar_sign: `:heavy_dollar_sign:`
:heavy_equals_sign: `:heavy_equals_sign:`
:heavy_exclamation_mark: `:heavy_exclamation_mark:`
:heavy_heart_exclamation: `:heavy_heart_exclamation:`
:heavy_minus_sign: `:heavy_minus_sign:`
:heavy_multiplication_x: `:heavy_multiplication_x:`
:heavy_plus_sign: `:heavy_plus_sign:`
:hedgehog: `:hedgehog:`
:helicopter: `:helicopter:`
:herb: `:herb:`
:hibiscus: `:hibiscus:`
:high_brightness: `:high_brightness:`
:high_heel: `:high_heel:`
:hiking_boot: `:hiking_boot:`
:hindu_temple: `:hindu_temple:`
:hippopotamus: `:hippopotamus:`
:hocho: `:hocho:`
:hole: `:hole:`
:honduras: `:honduras:`
:honey_pot: `:honey_pot:`
:honeybee: `:honeybee:`
:hong_kong: `:hong_kong:`
:hook: `:hook:`
:horse: `:horse:`
:horse_racing: `:horse_racing:`
:hospital: `:hospital:`
:hot_face: `:hot_face:`
:hot_pepper: `:hot_pepper:`
:hotdog: `:hotdog:`
:hotel: `:hotel:`
:hotsprings: `:hotsprings:`
:hourglass: `:hourglass:`
:hourglass_flowing_sand: `:hourglass_flowing_sand:`
:house: `:house:`
:house_with_garden: `:house_with_garden:`
:houses: `:houses:`
:hugs: `:hugs:`
:hungary: `:hungary:`
:hurtrealbad: `:hurtrealbad:`
:hushed: `:hushed:`
:hut: `:hut:`
:hyacinth: `:hyacinth:`
:ice_cream: `:ice_cream:`
:ice_cube: `:ice_cube:`
:ice_hockey: `:ice_hockey:`
:ice_skate: `:ice_skate:`
:icecream: `:icecream:`
:iceland: `:iceland:`
:id: `:id:`
:identification_card: `:identification_card:`
:ideograph_advantage: `:ideograph_advantage:`
:imp: `:imp:`
:inbox_tray: `:inbox_tray:`
:incoming_envelope: `:incoming_envelope:`
:index_pointing_at_the_viewer: `:index_pointing_at_the_viewer:`
:india: `:india:`
:indonesia: `:indonesia:`
:infinity: `:infinity:`
:information_desk_person: `:information_desk_person:`
:information_source: `:information_source:`
:innocent: `:innocent:`
:interrobang: `:interrobang:`
:iphone: `:iphone:`
:iran: `:iran:`
:iraq: `:iraq:`
:ireland: `:ireland:`
:isle_of_man: `:isle_of_man:`
:israel: `:israel:`
:it: `:it:`
:izakaya_lantern: `:izakaya_lantern:`
:jack_o_lantern: `:jack_o_lantern:`
:jamaica: `:jamaica:`
:japan: `:japan:`
:japanese_castle: `:japanese_castle:`
:japanese_goblin: `:japanese_goblin:`
:japanese_ogre: `:japanese_ogre:`
:jar: `:jar:`
:jeans: `:jeans:`
:jellyfish: `:jellyfish:`
:jersey: `:jersey:`
:jigsaw: `:jigsaw:`
:jordan: `:jordan:`
:joy: `:joy:`
:joy_cat: `:joy_cat:`
:joystick: `:joystick:`
:jp: `:jp:`
:judge: `:judge:`
:juggling_person: `:juggling_person:`
:kaaba: `:kaaba:`
:kangaroo: `:kangaroo:`
:kazakhstan: `:kazakhstan:`
:kenya: `:kenya:`
:key: `:key:`
:keyboard: `:keyboard:`
:keycap_ten: `:keycap_ten:`
:khanda: `:khanda:`
:kick_scooter: `:kick_scooter:`
:kimono: `:kimono:`
:kiribati: `:kiribati:`
:kiss: `:kiss:`
:kissing: `:kissing:`
:kissing_cat: `:kissing_cat:`
:kissing_closed_eyes: `:kissing_closed_eyes:`
:kissing_heart: `:kissing_heart:`
:kissing_smiling_eyes: `:kissing_smiling_eyes:`
:kite: `:kite:`
:kiwi_fruit: `:kiwi_fruit:`
:kneeling_man: `:kneeling_man:`
:kneeling_person: `:kneeling_person:`
:kneeling_woman: `:kneeling_woman:`
:knife: `:knife:`
:knot: `:knot:`
:koala: `:koala:`
:koko: `:koko:`
:kosovo: `:kosovo:`
:kr: `:kr:`
:kuwait: `:kuwait:`
:kyrgyzstan: `:kyrgyzstan:`
:lab_coat: `:lab_coat:`
:label: `:label:`
:lacrosse: `:lacrosse:`
:ladder: `:ladder:`
:lady_beetle: `:lady_beetle:`
:lantern: `:lantern:`
:laos: `:laos:`
:large_blue_circle: `:large_blue_circle:`
:large_blue_diamond: `:large_blue_diamond:`
:large_orange_diamond: `:large_orange_diamond:`
:last_quarter_moon: `:last_quarter_moon:`
:last_quarter_moon_with_face: `:last_quarter_moon_with_face:`
:latin_cross: `:latin_cross:`
:latvia: `:latvia:`
:laughing: `:laughing:`
:leafy_green: `:leafy_green:`
:leaves: `:leaves:`
:lebanon: `:lebanon:`
:ledger: `:ledger:`
:left_luggage: `:left_luggage:`
:left_right_arrow: `:left_right_arrow:`
:left_speech_bubble: `:left_speech_bubble:`
:leftwards_arrow_with_hook: `:leftwards_arrow_with_hook:`
:leftwards_hand: `:leftwards_hand:`
:leftwards_pushing_hand: `:leftwards_pushing_hand:`
:leg: `:leg:`
:lemon: `:lemon:`
:leo: `:leo:`
:leopard: `:leopard:`
:lesotho: `:lesotho:`
:level_slider: `:level_slider:`
:liberia: `:liberia:`
:libra: `:libra:`
:libya: `:libya:`
:liechtenstein: `:liechtenstein:`
:light_blue_heart: `:light_blue_heart:`
:light_rail: `:light_rail:`
:link: `:link:`
:lion: `:lion:`
:lips: `:lips:`
:lipstick: `:lipstick:`
:lithuania: `:lithuania:`
:lizard: `:lizard:`
:llama: `:llama:`
:lobster: `:lobster:`
:lock: `:lock:`
:lock_with_ink_pen: `:lock_with_ink_pen:`
:lollipop: `:lollipop:`
:long_drum: `:long_drum:`
:loop: `:loop:`
:lotion_bottle: `:lotion_bottle:`
:lotus: `:lotus:`
:lotus_position: `:lotus_position:`
:lotus_position_man: `:lotus_position_man:`
:lotus_position_woman: `:lotus_position_woman:`
:loud_sound: `:loud_sound:`
:loudspeaker: `:loudspeaker:`
:love_hotel: `:love_hotel:`
:love_letter: `:love_letter:`
:love_you_gesture: `:love_you_gesture:`
:low_battery: `:low_battery:`
:low_brightness: `:low_brightness:`
:luggage: `:luggage:`
:lungs: `:lungs:`
:luxembourg: `:luxembourg:`
:lying_face: `:lying_face:`
:m: `:m:`
:macau: `:macau:`
:macedonia: `:macedonia:`
:madagascar: `:madagascar:`
:mag: `:mag:`
:mag_right: `:mag_right:`
:mage: `:mage:`
:mage_man: `:mage_man:`
:mage_woman: `:mage_woman:`
:magic_wand: `:magic_wand:`
:magnet: `:magnet:`
:mahjong: `:mahjong:`
:mailbox: `:mailbox:`
:mailbox_closed: `:mailbox_closed:`
:mailbox_with_mail: `:mailbox_with_mail:`
:mailbox_with_no_mail: `:mailbox_with_no_mail:`
:malawi: `:malawi:`
:malaysia: `:malaysia:`
:maldives: `:maldives:`
:male_detective: `:male_detective:`
:male_sign: `:male_sign:`
:mali: `:mali:`
:malta: `:malta:`
:mammoth: `:mammoth:`
:man: `:man:`
:man_artist: `:man_artist:`
:man_astronaut: `:man_astronaut:`
:man_beard: `:man_beard:`
:man_cartwheeling: `:man_cartwheeling:`
:man_cook: `:man_cook:`
:man_dancing: `:man_dancing:`
:man_facepalming: `:man_facepalming:`
:man_factory_worker: `:man_factory_worker:`
:man_farmer: `:man_farmer:`
:man_feeding_baby: `:man_feeding_baby:`
:man_firefighter: `:man_firefighter:`
:man_health_worker: `:man_health_worker:`
:man_in_manual_wheelchair: `:man_in_manual_wheelchair:`
:man_in_motorized_wheelchair: `:man_in_motorized_wheelchair:`
:man_in_tuxedo: `:man_in_tuxedo:`
:man_judge: `:man_judge:`
:man_juggling: `:man_juggling:`
:man_mechanic: `:man_mechanic:`
:man_office_worker: `:man_office_worker:`
:man_pilot: `:man_pilot:`
:man_playing_handball: `:man_playing_handball:`
:man_playing_water_polo: `:man_playing_water_polo:`
:man_scientist: `:man_scientist:`
:man_shrugging: `:man_shrugging:`
:man_singer: `:man_singer:`
:man_student: `:man_student:`
:man_teacher: `:man_teacher:`
:man_technologist: `:man_technologist:`
:man_with_gua_pi_mao: `:man_with_gua_pi_mao:`
:man_with_probing_cane: `:man_with_probing_cane:`
:man_with_turban: `:man_with_turban:`
:man_with_veil: `:man_with_veil:`
:mandarin: `:mandarin:`
:mango: `:mango:`
:mans_shoe: `:mans_shoe:`
:mantelpiece_clock: `:mantelpiece_clock:`
:manual_wheelchair: `:manual_wheelchair:`
:maple_leaf: `:maple_leaf:`
:maracas: `:maracas:`
:marshall_islands: `:marshall_islands:`
:martial_arts_uniform: `:martial_arts_uniform:`
:martinique: `:martinique:`
:mask: `:mask:`
:massage: `:massage:`
:massage_man: `:massage_man:`
:massage_woman: `:massage_woman:`
:mate: `:mate:`
:mauritania: `:mauritania:`
:mauritius: `:mauritius:`
:mayotte: `:mayotte:`
:meat_on_bone: `:meat_on_bone:`
:mechanic: `:mechanic:`
:mechanical_arm: `:mechanical_arm:`
:mechanical_leg: `:mechanical_leg:`
:medal_military: `:medal_military:`
:medal_sports: `:medal_sports:`
:medical_symbol: `:medical_symbol:`
:mega: `:mega:`
:melon: `:melon:`
:melting_face: `:melting_face:`
:memo: `:memo:`
:men_wrestling: `:men_wrestling:`
:mending_heart: `:mending_heart:`
:menorah: `:menorah:`
:mens: `:mens:`
:mermaid: `:mermaid:`
:merman: `:merman:`
:merperson: `:merperson:`
:metal: `:metal:`
:metro: `:metro:`
:mexico: `:mexico:`
:microbe: `:microbe:`
:micronesia: `:micronesia:`
:microphone: `:microphone:`
:microscope: `:microscope:`
:middle_finger: `:middle_finger:`
:military_helmet: `:military_helmet:`
:milk_glass: `:milk_glass:`
:milky_way: `:milky_way:`
:minibus: `:minibus:`
:minidisc: `:minidisc:`
:mirror: `:mirror:`
:mirror_ball: `:mirror_ball:`
:mobile_phone_off: `:mobile_phone_off:`
:moldova: `:moldova:`
:monaco: `:monaco:`
:money_mouth_face: `:money_mouth_face:`
:money_with_wings: `:money_with_wings:`
:moneybag: `:moneybag:`
:mongolia: `:mongolia:`
:monkey: `:monkey:`
:monkey_face: `:monkey_face:`
:monocle_face: `:monocle_face:`
:monorail: `:monorail:`
:montenegro: `:montenegro:`
:montserrat: `:montserrat:`
:moon: `:moon:`
:moon_cake: `:moon_cake:`
:moose: `:moose:`
:morocco: `:morocco:`
:mortar_board: `:mortar_board:`
:mosque: `:mosque:`
:mosquito: `:mosquito:`
:motor_boat: `:motor_boat:`
:motor_scooter: `:motor_scooter:`
:motorcycle: `:motorcycle:`
:motorized_wheelchair: `:motorized_wheelchair:`
:motorway: `:motorway:`
:mount_fuji: `:mount_fuji:`
:mountain: `:mountain:`
:mountain_bicyclist: `:mountain_bicyclist:`
:mountain_biking_man: `:mountain_biking_man:`
:mountain_biking_woman: `:mountain_biking_woman:`
:mountain_cableway: `:mountain_cableway:`
:mountain_railway: `:mountain_railway:`
:mountain_snow: `:mountain_snow:`
:mouse: `:mouse:`
:mouse2: `:mouse2:`
:mouse_trap: `:mouse_trap:`
:movie_camera: `:movie_camera:`
:moyai: `:moyai:`
:mozambique: `:mozambique:`
:mrs_claus: `:mrs_claus:`
:muscle: `:muscle:`
:mushroom: `:mushroom:`
:musical_keyboard: `:musical_keyboard:`
:musical_note: `:musical_note:`
:musical_score: `:musical_score:`
:mute: `:mute:`
:mx_claus: `:mx_claus:`
:myanmar: `:myanmar:`
:nail_care: `:nail_care:`
:name_badge: `:name_badge:`
:namibia: `:namibia:`
:national_park: `:national_park:`
:nauru: `:nauru:`
:nauseated_face: `:nauseated_face:`
:nazar_amulet: `:nazar_amulet:`
:neckbeard: `:neckbeard:`
:necktie: `:necktie:`
:negative_squared_cross_mark: `:negative_squared_cross_mark:`
:nepal: `:nepal:`
:nerd_face: `:nerd_face:`
:nest_with_eggs: `:nest_with_eggs:`
:nesting_dolls: `:nesting_dolls:`
:netherlands: `:netherlands:`
:neutral_face: `:neutral_face:`
:new: `:new:`
:new_caledonia: `:new_caledonia:`
:new_moon: `:new_moon:`
:new_moon_with_face: `:new_moon_with_face:`
:new_zealand: `:new_zealand:`
:newspaper: `:newspaper:`
:newspaper_roll: `:newspaper_roll:`
:next_track_button: `:next_track_button:`
:ng: `:ng:`
:ng_man: `:ng_man:`
:ng_woman: `:ng_woman:`
:nicaragua: `:nicaragua:`
:niger: `:niger:`
:nigeria: `:nigeria:`
:night_with_stars: `:night_with_stars:`
:nine: `:nine:`
:ninja: `:ninja:`
:niue: `:niue:`
:no_bell: `:no_bell:`
:no_bicycles: `:no_bicycles:`
:no_entry: `:no_entry:`
:no_entry_sign: `:no_entry_sign:`
:no_good: `:no_good:`
:no_good_man: `:no_good_man:`
:no_good_woman: `:no_good_woman:`
:no_mobile_phones: `:no_mobile_phones:`
:no_mouth: `:no_mouth:`
:no_pedestrians: `:no_pedestrians:`
:no_smoking: `:no_smoking:`
:non-potable_water: `:non-potable_water:`
:norfolk_island: `:norfolk_island:`
:north_korea: `:north_korea:`
:northern_mariana_islands: `:northern_mariana_islands:`
:norway: `:norway:`
:nose: `:nose:`
:notebook: `:notebook:`
:notebook_with_decorative_cover: `:notebook_with_decorative_cover:`
:notes: `:notes:`
:nut_and_bolt: `:nut_and_bolt:`
:o: `:o:`
:o2: `:o2:`
:ocean: `:ocean:`
:octocat: `:octocat:`
:octopus: `:octopus:`
:oden: `:oden:`
:office: `:office:`
:office_worker: `:office_worker:`
:oil_drum: `:oil_drum:`
:ok: `:ok:`
:ok_hand: `:ok_hand:`
:ok_man: `:ok_man:`
:ok_person: `:ok_person:`
:ok_woman: `:ok_woman:`
:old_key: `:old_key:`
:older_adult: `:older_adult:`
:older_man: `:older_man:`
:older_woman: `:older_woman:`
:olive: `:olive:`
:om: `:om:`
:oman: `:oman:`
:on: `:on:`
:oncoming_automobile: `:oncoming_automobile:`
:oncoming_bus: `:oncoming_bus:`
:oncoming_police_car: `:oncoming_police_car:`
:oncoming_taxi: `:oncoming_taxi:`
:one: `:one:`
:one_piece_swimsuit: `:one_piece_swimsuit:`
:onion: `:onion:`
:open_book: `:open_book:`
:open_file_folder: `:open_file_folder:`
:open_hands: `:open_hands:`
:open_mouth: `:open_mouth:`
:open_umbrella: `:open_umbrella:`
:ophiuchus: `:ophiuchus:`
:orange: `:orange:`
:orange_book: `:orange_book:`
:orange_circle: `:orange_circle:`
:orange_heart: `:orange_heart:`
:orange_square: `:orange_square:`
:orangutan: `:orangutan:`
:orthodox_cross: `:orthodox_cross:`
:otter: `:otter:`
:outbox_tray: `:outbox_tray:`
:owl: `:owl:`
:ox: `:ox:`
:oyster: `:oyster:`
:package: `:package:`
:page_facing_up: `:page_facing_up:`
:page_with_curl: `:page_with_curl:`
:pager: `:pager:`
:paintbrush: `:paintbrush:`
:pakistan: `:pakistan:`
:palau: `:palau:`
:palestinian_territories: `:palestinian_territories:`
:palm_down_hand: `:palm_down_hand:`
:palm_tree: `:palm_tree:`
:palm_up_hand: `:palm_up_hand:`
:palms_up_together: `:palms_up_together:`
:panama: `:panama:`
:pancakes: `:pancakes:`
:panda_face: `:panda_face:`
:paperclip: `:paperclip:`
:paperclips: `:paperclips:`
:papua_new_guinea: `:papua_new_guinea:`
:parachute: `:parachute:`
:paraguay: `:paraguay:`
:parasol_on_ground: `:parasol_on_ground:`
:parking: `:parking:`
:parrot: `:parrot:`
:part_alternation_mark: `:part_alternation_mark:`
:partly_sunny: `:partly_sunny:`
:partying_face: `:partying_face:`
:passenger_ship: `:passenger_ship:`
:passport_control: `:passport_control:`
:pause_button: `:pause_button:`
:paw_prints: `:paw_prints:`
:pea_pod: `:pea_pod:`
:peace_symbol: `:peace_symbol:`
:peach: `:peach:`
:peacock: `:peacock:`
:peanuts: `:peanuts:`
:pear: `:pear:`
:pen: `:pen:`
:pencil: `:pencil:`
:pencil2: `:pencil2:`
:penguin: `:penguin:`
:pensive: `:pensive:`
:people_holding_hands: `:people_holding_hands:`
:people_hugging: `:people_hugging:`
:performing_arts: `:performing_arts:`
:persevere: `:persevere:`
:person_bald: `:person_bald:`
:person_curly_hair: `:person_curly_hair:`
:person_feeding_baby: `:person_feeding_baby:`
:person_fencing: `:person_fencing:`
:person_in_manual_wheelchair: `:person_in_manual_wheelchair:`
:person_in_motorized_wheelchair: `:person_in_motorized_wheelchair:`
:person_in_tuxedo: `:person_in_tuxedo:`
:person_red_hair: `:person_red_hair:`
:person_white_hair: `:person_white_hair:`
:person_with_crown: `:person_with_crown:`
:person_with_probing_cane: `:person_with_probing_cane:`
:person_with_turban: `:person_with_turban:`
:person_with_veil: `:person_with_veil:`
:peru: `:peru:`
:petri_dish: `:petri_dish:`
:philippines: `:philippines:`
:phone: `:phone:`
:pick: `:pick:`
:pickup_truck: `:pickup_truck:`
:pie: `:pie:`
:pig: `:pig:`
:pig2: `:pig2:`
:pig_nose: `:pig_nose:`
:pill: `:pill:`
:pilot: `:pilot:`
:pinata: `:pinata:`
:pinched_fingers: `:pinched_fingers:`
:pinching_hand: `:pinching_hand:`
:pineapple: `:pineapple:`
:ping_pong: `:ping_pong:`
:pink_heart: `:pink_heart:`
:pirate_flag: `:pirate_flag:`
:pisces: `:pisces:`
:pitcairn_islands: `:pitcairn_islands:`
:pizza: `:pizza:`
:placard: `:placard:`
:place_of_worship: `:place_of_worship:`
:plate_with_cutlery: `:plate_with_cutlery:`
:play_or_pause_button: `:play_or_pause_button:`
:playground_slide: `:playground_slide:`
:pleading_face: `:pleading_face:`
:plunger: `:plunger:`
:point_down: `:point_down:`
:point_left: `:point_left:`
:point_right: `:point_right:`
:point_up: `:point_up:`
:point_up_2: `:point_up_2:`
:poland: `:poland:`
:polar_bear: `:polar_bear:`
:police_car: `:police_car:`
:police_officer: `:police_officer:`
:policeman: `:policeman:`
:policewoman: `:policewoman:`
:poodle: `:poodle:`
:poop: `:poop:`
:popcorn: `:popcorn:`
:portugal: `:portugal:`
:post_office: `:post_office:`
:postal_horn: `:postal_horn:`
:postbox: `:postbox:`
:potable_water: `:potable_water:`
:potato: `:potato:`
:potted_plant: `:potted_plant:`
:pouch: `:pouch:`
:poultry_leg: `:poultry_leg:`
:pound: `:pound:`
:pouring_liquid: `:pouring_liquid:`
:pout: `:pout:`
:pouting_cat: `:pouting_cat:`
:pouting_face: `:pouting_face:`
:pouting_man: `:pouting_man:`
:pouting_woman: `:pouting_woman:`
:pray: `:pray:`
:prayer_beads: `:prayer_beads:`
:pregnant_man: `:pregnant_man:`
:pregnant_person: `:pregnant_person:`
:pregnant_woman: `:pregnant_woman:`
:pretzel: `:pretzel:`
:previous_track_button: `:previous_track_button:`
:prince: `:prince:`
:princess: `:princess:`
:printer: `:printer:`
:probing_cane: `:probing_cane:`
:puerto_rico: `:puerto_rico:`
:punch: `:punch:`
:purple_circle: `:purple_circle:`
:purple_heart: `:purple_heart:`
:purple_square: `:purple_square:`
:purse: `:purse:`
:pushpin: `:pushpin:`
:put_litter_in_its_place: `:put_litter_in_its_place:`
:qatar: `:qatar:`
:question: `:question:`
:rabbit: `:rabbit:`
:rabbit2: `:rabbit2:`
:raccoon: `:raccoon:`
:racehorse: `:racehorse:`
:racing_car: `:racing_car:`
:radio: `:radio:`
:radio_button: `:radio_button:`
:radioactive: `:radioactive:`
:rage: `:rage:`
:rage1: `:rage1:`
:rage2: `:rage2:`
:rage3: `:rage3:`
:rage4: `:rage4:`
:railway_car: `:railway_car:`
:railway_track: `:railway_track:`
:rainbow: `:rainbow:`
:rainbow_flag: `:rainbow_flag:`
:raised_back_of_hand: `:raised_back_of_hand:`
:raised_eyebrow: `:raised_eyebrow:`
:raised_hand: `:raised_hand:`
:raised_hand_with_fingers_splayed: `:raised_hand_with_fingers_splayed:`
:raised_hands: `:raised_hands:`
:raising_hand: `:raising_hand:`
:raising_hand_man: `:raising_hand_man:`
:raising_hand_woman: `:raising_hand_woman:`
:ram: `:ram:`
:ramen: `:ramen:`
:rat: `:rat:`
:razor: `:razor:`
:receipt: `:receipt:`
:record_button: `:record_button:`
:recycle: `:recycle:`
:red_car: `:red_car:`
:red_circle: `:red_circle:`
:red_envelope: `:red_envelope:`
:red_haired_man: `:red_haired_man:`
:red_haired_woman: `:red_haired_woman:`
:red_square: `:red_square:`
:registered: `:registered:`
:relaxed: `:relaxed:`
:relieved: `:relieved:`
:reminder_ribbon: `:reminder_ribbon:`
:repeat: `:repeat:`
:repeat_one: `:repeat_one:`
:rescue_worker_helmet: `:rescue_worker_helmet:`
:restroom: `:restroom:`
:reunion: `:reunion:`
:revolving_hearts: `:revolving_hearts:`
:rewind: `:rewind:`
:rhinoceros: `:rhinoceros:`
:ribbon: `:ribbon:`
:rice: `:rice:`
:rice_ball: `:rice_ball:`
:rice_cracker: `:rice_cracker:`
:rice_scene: `:rice_scene:`
:right_anger_bubble: `:right_anger_bubble:`
:rightwards_hand: `:rightwards_hand:`
:rightwards_pushing_hand: `:rightwards_pushing_hand:`
:ring: `:ring:`
:ring_buoy: `:ring_buoy:`
:ringed_planet: `:ringed_planet:`
:robot: `:robot:`
:rock: `:rock:`
:rocket: `:rocket:`
:rofl: `:rofl:`
:roll_eyes: `:roll_eyes:`
:roll_of_paper: `:roll_of_paper:`
:roller_coaster: `:roller_coaster:`
:roller_skate: `:roller_skate:`
:romania: `:romania:`
:rooster: `:rooster:`
:rose: `:rose:`
:rosette: `:rosette:`
:rotating_light: `:rotating_light:`
:round_pushpin: `:round_pushpin:`
:rowboat: `:rowboat:`
:rowing_man: `:rowing_man:`
:rowing_woman: `:rowing_woman:`
:ru: `:ru:`
:rugby_football: `:rugby_football:`
:runner: `:runner:`
:running: `:running:`
:running_man: `:running_man:`
:running_shirt_with_sash: `:running_shirt_with_sash:`
:running_woman: `:running_woman:`
:rwanda: `:rwanda:`
:sa: `:sa:`
:safety_pin: `:safety_pin:`
:safety_vest: `:safety_vest:`
:sagittarius: `:sagittarius:`
:sailboat: `:sailboat:`
:sake: `:sake:`
:salt: `:salt:`
:saluting_face: `:saluting_face:`
:samoa: `:samoa:`
:san_marino: `:san_marino:`
:sandal: `:sandal:`
:sandwich: `:sandwich:`
:santa: `:santa:`
:sao_tome_principe: `:sao_tome_principe:`
:sari: `:sari:`
:sassy_man: `:sassy_man:`
:sassy_woman: `:sassy_woman:`
:satellite: `:satellite:`
:satisfied: `:satisfied:`
:saudi_arabia: `:saudi_arabia:`
:sauna_man: `:sauna_man:`
:sauna_person: `:sauna_person:`
:sauna_woman: `:sauna_woman:`
:sauropod: `:sauropod:`
:saxophone: `:saxophone:`
:scarf: `:scarf:`
:school: `:school:`
:school_satchel: `:school_satchel:`
:scientist: `:scientist:`
:scissors: `:scissors:`
:scorpion: `:scorpion:`
:scorpius: `:scorpius:`
:scotland: `:scotland:`
:scream: `:scream:`
:scream_cat: `:scream_cat:`
:screwdriver: `:screwdriver:`
:scroll: `:scroll:`
:seal: `:seal:`
:seat: `:seat:`
:secret: `:secret:`
:see_no_evil: `:see_no_evil:`
:seedling: `:seedling:`
:selfie: `:selfie:`
:senegal: `:senegal:`
:serbia: `:serbia:`
:service_dog: `:service_dog:`
:seven: `:seven:`
:sewing_needle: `:sewing_needle:`
:seychelles: `:seychelles:`
:shaking_face: `:shaking_face:`
:shallow_pan_of_food: `:shallow_pan_of_food:`
:shamrock: `:shamrock:`
:shark: `:shark:`
:shaved_ice: `:shaved_ice:`
:sheep: `:sheep:`
:shell: `:shell:`
:shield: `:shield:`
:shinto_shrine: `:shinto_shrine:`
:ship: `:ship:`
:shipit: `:shipit:`
:shirt: `:shirt:`
:shit: `:shit:`
:shoe: `:shoe:`
:shopping: `:shopping:`
:shopping_cart: `:shopping_cart:`
:shorts: `:shorts:`
:shower: `:shower:`
:shrimp: `:shrimp:`
:shrug: `:shrug:`
:shushing_face: `:shushing_face:`
:sierra_leone: `:sierra_leone:`
:signal_strength: `:signal_strength:`
:singapore: `:singapore:`
:singer: `:singer:`
:sint_maarten: `:sint_maarten:`
:six: `:six:`
:six_pointed_star: `:six_pointed_star:`
:skateboard: `:skateboard:`
:ski: `:ski:`
:skier: `:skier:`
:skull: `:skull:`
:skull_and_crossbones: `:skull_and_crossbones:`
:skunk: `:skunk:`
:sled: `:sled:`
:sleeping: `:sleeping:`
:sleeping_bed: `:sleeping_bed:`
:sleepy: `:sleepy:`
:slightly_frowning_face: `:slightly_frowning_face:`
:slightly_smiling_face: `:slightly_smiling_face:`
:slot_machine: `:slot_machine:`
:sloth: `:sloth:`
:slovakia: `:slovakia:`
:slovenia: `:slovenia:`
:small_airplane: `:small_airplane:`
:small_blue_diamond: `:small_blue_diamond:`
:small_orange_diamond: `:small_orange_diamond:`
:small_red_triangle: `:small_red_triangle:`
:small_red_triangle_down: `:small_red_triangle_down:`
:smile: `:smile:`
:smile_cat: `:smile_cat:`
:smiley: `:smiley:`
:smiley_cat: `:smiley_cat:`
:smiling_face_with_tear: `:smiling_face_with_tear:`
:smiling_face_with_three_hearts: `:smiling_face_with_three_hearts:`
:smiling_imp: `:smiling_imp:`
:smirk: `:smirk:`
:smirk_cat: `:smirk_cat:`
:smoking: `:smoking:`
:snail: `:snail:`
:snake: `:snake:`
:sneezing_face: `:sneezing_face:`
:snowboarder: `:snowboarder:`
:snowflake: `:snowflake:`
:snowman: `:snowman:`
:snowman_with_snow: `:snowman_with_snow:`
:soap: `:soap:`
:sob: `:sob:`
:soccer: `:soccer:`
:socks: `:socks:`
:softball: `:softball:`
:solomon_islands: `:solomon_islands:`
:somalia: `:somalia:`
:soon: `:soon:`
:sos: `:sos:`
:sound: `:sound:`
:south_africa: `:south_africa:`
:south_georgia_south_sandwich_islands: `:south_georgia_south_sandwich_islands:`
:south_sudan: `:south_sudan:`
:space_invader: `:space_invader:`
:spades: `:spades:`
:spaghetti: `:spaghetti:`
:sparkle: `:sparkle:`
:sparkler: `:sparkler:`
:sparkles: `:sparkles:`
:sparkling_heart: `:sparkling_heart:`
:speak_no_evil: `:speak_no_evil:`
:speaker: `:speaker:`
:speaking_head: `:speaking_head:`
:speech_balloon: `:speech_balloon:`
:speedboat: `:speedboat:`
:spider: `:spider:`
:spider_web: `:spider_web:`
:spiral_calendar: `:spiral_calendar:`
:spiral_notepad: `:spiral_notepad:`
:sponge: `:sponge:`
:spoon: `:spoon:`
:squid: `:squid:`
:sri_lanka: `:sri_lanka:`
:st_barthelemy: `:st_barthelemy:`
:st_helena: `:st_helena:`
:st_kitts_nevis: `:st_kitts_nevis:`
:st_lucia: `:st_lucia:`
:st_martin: `:st_martin:`
:st_pierre_miquelon: `:st_pierre_miquelon:`
:st_vincent_grenadines: `:st_vincent_grenadines:`
:stadium: `:stadium:`
:standing_man: `:standing_man:`
:standing_person: `:standing_person:`
:standing_woman: `:standing_woman:`
:star: `:star:`
:star2: `:star2:`
:star_and_crescent: `:star_and_crescent:`
:star_of_david: `:star_of_david:`
:star_struck: `:star_struck:`
:stars: `:stars:`
:station: `:station:`
:statue_of_liberty: `:statue_of_liberty:`
:steam_locomotive: `:steam_locomotive:`
:stethoscope: `:stethoscope:`
:stew: `:stew:`
:stop_button: `:stop_button:`
:stop_sign: `:stop_sign:`
:stopwatch: `:stopwatch:`
:straight_ruler: `:straight_ruler:`
:strawberry: `:strawberry:`
:stuck_out_tongue: `:stuck_out_tongue:`
:stuck_out_tongue_closed_eyes: `:stuck_out_tongue_closed_eyes:`
:stuck_out_tongue_winking_eye: `:stuck_out_tongue_winking_eye:`
:student: `:student:`
:studio_microphone: `:studio_microphone:`
:stuffed_flatbread: `:stuffed_flatbread:`
:sudan: `:sudan:`
:sun_behind_large_cloud: `:sun_behind_large_cloud:`
:sun_behind_rain_cloud: `:sun_behind_rain_cloud:`
:sun_behind_small_cloud: `:sun_behind_small_cloud:`
:sun_with_face: `:sun_with_face:`
:sunflower: `:sunflower:`
:sunglasses: `:sunglasses:`
:sunny: `:sunny:`
:sunrise: `:sunrise:`
:sunrise_over_mountains: `:sunrise_over_mountains:`
:superhero: `:superhero:`
:superhero_man: `:superhero_man:`
:superhero_woman: `:superhero_woman:`
:supervillain: `:supervillain:`
:supervillain_man: `:supervillain_man:`
:supervillain_woman: `:supervillain_woman:`
:surfer: `:surfer:`
:surfing_man: `:surfing_man:`
:surfing_woman: `:surfing_woman:`
:suriname: `:suriname:`
:sushi: `:sushi:`
:suspect: `:suspect:`
:suspension_railway: `:suspension_railway:`
:svalbard_jan_mayen: `:svalbard_jan_mayen:`
:swan: `:swan:`
:swaziland: `:swaziland:`
:sweat: `:sweat:`
:sweat_drops: `:sweat_drops:`
:sweat_smile: `:sweat_smile:`
:sweden: `:sweden:`
:sweet_potato: `:sweet_potato:`
:swim_brief: `:swim_brief:`
:swimmer: `:swimmer:`
:swimming_man: `:swimming_man:`
:swimming_woman: `:swimming_woman:`
:switzerland: `:switzerland:`
:symbols: `:symbols:`
:synagogue: `:synagogue:`
:syria: `:syria:`
:syringe: `:syringe:`
:t-rex: `:t-rex:`
:taco: `:taco:`
:tada: `:tada:`
:taiwan: `:taiwan:`
:tajikistan: `:tajikistan:`
:takeout_box: `:takeout_box:`
:tamale: `:tamale:`
:tanabata_tree: `:tanabata_tree:`
:tangerine: `:tangerine:`
:tanzania: `:tanzania:`
:taurus: `:taurus:`
:taxi: `:taxi:`
:tea: `:tea:`
:teacher: `:teacher:`
:teapot: `:teapot:`
:technologist: `:technologist:`
:teddy_bear: `:teddy_bear:`
:telephone: `:telephone:`
:telephone_receiver: `:telephone_receiver:`
:telescope: `:telescope:`
:tennis: `:tennis:`
:tent: `:tent:`
:test_tube: `:test_tube:`
:thailand: `:thailand:`
:thermometer: `:thermometer:`
:thinking: `:thinking:`
:thong_sandal: `:thong_sandal:`
:thought_balloon: `:thought_balloon:`
:thread: `:thread:`
:three: `:three:`
:thumbsdown: `:thumbsdown:`
:thumbsup: `:thumbsup:`
:ticket: `:ticket:`
:tickets: `:tickets:`
:tiger: `:tiger:`
:tiger2: `:tiger2:`
:timer_clock: `:timer_clock:`
:timor_leste: `:timor_leste:`
:tipping_hand_man: `:tipping_hand_man:`
:tipping_hand_person: `:tipping_hand_person:`
:tipping_hand_woman: `:tipping_hand_woman:`
:tired_face: `:tired_face:`
:tm: `:tm:`
:togo: `:togo:`
:toilet: `:toilet:`
:tokelau: `:tokelau:`
:tokyo_tower: `:tokyo_tower:`
:tomato: `:tomato:`
:tonga: `:tonga:`
:tongue: `:tongue:`
:toolbox: `:toolbox:`
:tooth: `:tooth:`
:toothbrush: `:toothbrush:`
:top: `:top:`
:tophat: `:tophat:`
:tornado: `:tornado:`
:tr: `:tr:`
:trackball: `:trackball:`
:tractor: `:tractor:`
:traffic_light: `:traffic_light:`
:train: `:train:`
:train2: `:train2:`
:tram: `:tram:`
:transgender_flag: `:transgender_flag:`
:transgender_symbol: `:transgender_symbol:`
:triangular_flag_on_post: `:triangular_flag_on_post:`
:triangular_ruler: `:triangular_ruler:`
:trident: `:trident:`
:trinidad_tobago: `:trinidad_tobago:`
:tristan_da_cunha: `:tristan_da_cunha:`
:triumph: `:triumph:`
:troll: `:troll:`
:trolleybus: `:trolleybus:`
:trollface: `:trollface:`
:trophy: `:trophy:`
:tropical_drink: `:tropical_drink:`
:tropical_fish: `:tropical_fish:`
:truck: `:truck:`
:trumpet: `:trumpet:`
:tshirt: `:tshirt:`
:tulip: `:tulip:`
:tumbler_glass: `:tumbler_glass:`
:tunisia: `:tunisia:`
:turkey: `:turkey:`
:turkmenistan: `:turkmenistan:`
:turks_caicos_islands: `:turks_caicos_islands:`
:turtle: `:turtle:`
:tuvalu: `:tuvalu:`
:tv: `:tv:`
:twisted_rightwards_arrows: `:twisted_rightwards_arrows:`
:two: `:two:`
:two_hearts: `:two_hearts:`
:two_men_holding_hands: `:two_men_holding_hands:`
:two_women_holding_hands: `:two_women_holding_hands:`
:u5272: `:u5272:`
:u5408: `:u5408:`
:u55b6: `:u55b6:`
:u6307: `:u6307:`
:u6708: `:u6708:`
:u6709: `:u6709:`
:u6e80: `:u6e80:`
:u7121: `:u7121:`
:u7533: `:u7533:`
:u7981: `:u7981:`
:u7a7a: `:u7a7a:`
:uganda: `:uganda:`
:uk: `:uk:`
:ukraine: `:ukraine:`
:umbrella: `:umbrella:`
:unamused: `:unamused:`
:underage: `:underage:`
:unicorn: `:unicorn:`
:united_arab_emirates: `:united_arab_emirates:`
:united_nations: `:united_nations:`
:unlock: `:unlock:`
:up: `:up:`
:upside_down_face: `:upside_down_face:`
:uruguay: `:uruguay:`
:us: `:us:`
:us_outlying_islands: `:us_outlying_islands:`
:us_virgin_islands: `:us_virgin_islands:`
:uzbekistan: `:uzbekistan:`
:v: `:v:`
:vampire: `:vampire:`
:vampire_man: `:vampire_man:`
:vampire_woman: `:vampire_woman:`
:vanuatu: `:vanuatu:`
:vatican_city: `:vatican_city:`
:venezuela: `:venezuela:`
:vertical_traffic_light: `:vertical_traffic_light:`
:vhs: `:vhs:`
:vibration_mode: `:vibration_mode:`
:video_camera: `:video_camera:`
:video_game: `:video_game:`
:vietnam: `:vietnam:`
:violin: `:violin:`
:virgo: `:virgo:`
:volcano: `:volcano:`
:volleyball: `:volleyball:`
:vomiting_face: `:vomiting_face:`
:vs: `:vs:`
:vulcan_salute: `:vulcan_salute:`
:waffle: `:waffle:`
:wales: `:wales:`
:walking: `:walking:`
:walking_man: `:walking_man:`
:walking_woman: `:walking_woman:`
:wallis_futuna: `:wallis_futuna:`
:waning_crescent_moon: `:waning_crescent_moon:`
:waning_gibbous_moon: `:waning_gibbous_moon:`
:warning: `:warning:`
:wastebasket: `:wastebasket:`
:watch: `:watch:`
:water_buffalo: `:water_buffalo:`
:water_polo: `:water_polo:`
:watermelon: `:watermelon:`
:wave: `:wave:`
:wavy_dash: `:wavy_dash:`
:waxing_crescent_moon: `:waxing_crescent_moon:`
:waxing_gibbous_moon: `:waxing_gibbous_moon:`
:wc: `:wc:`
:weary: `:weary:`
:wedding: `:wedding:`
:weight_lifting: `:weight_lifting:`
:weight_lifting_man: `:weight_lifting_man:`
:weight_lifting_woman: `:weight_lifting_woman:`
:western_sahara: `:western_sahara:`
:whale: `:whale:`
:whale2: `:whale2:`
:wheel: `:wheel:`
:wheel_of_dharma: `:wheel_of_dharma:`
:wheelchair: `:wheelchair:`
:white_check_mark: `:white_check_mark:`
:white_circle: `:white_circle:`
:white_flag: `:white_flag:`
:white_flower: `:white_flower:`
:white_haired_man: `:white_haired_man:`
:white_haired_woman: `:white_haired_woman:`
:white_heart: `:white_heart:`
:white_large_square: `:white_large_square:`
:white_medium_small_square: `:white_medium_small_square:`
:white_medium_square: `:white_medium_square:`
:white_small_square: `:white_small_square:`
:white_square_button: `:white_square_button:`
:wilted_flower: `:wilted_flower:`
:wind_chime: `:wind_chime:`
:wind_face: `:wind_face:`
:window: `:window:`
:wine_glass: `:wine_glass:`
:wing: `:wing:`
:wink: `:wink:`
:wireless: `:wireless:`
:wolf: `:wolf:`
:woman: `:woman:`
:woman_artist: `:woman_artist:`
:woman_astronaut: `:woman_astronaut:`
:woman_beard: `:woman_beard:`
:woman_cartwheeling: `:woman_cartwheeling:`
:woman_cook: `:woman_cook:`
:woman_dancing: `:woman_dancing:`
:woman_facepalming: `:woman_facepalming:`
:woman_factory_worker: `:woman_factory_worker:`
:woman_farmer: `:woman_farmer:`
:woman_feeding_baby: `:woman_feeding_baby:`
:woman_firefighter: `:woman_firefighter:`
:woman_health_worker: `:woman_health_worker:`
:woman_in_manual_wheelchair: `:woman_in_manual_wheelchair:`
:woman_in_motorized_wheelchair: `:woman_in_motorized_wheelchair:`
:woman_in_tuxedo: `:woman_in_tuxedo:`
:woman_judge: `:woman_judge:`
:woman_juggling: `:woman_juggling:`
:woman_mechanic: `:woman_mechanic:`
:woman_office_worker: `:woman_office_worker:`
:woman_pilot: `:woman_pilot:`
:woman_playing_handball: `:woman_playing_handball:`
:woman_playing_water_polo: `:woman_playing_water_polo:`
:woman_scientist: `:woman_scientist:`
:woman_shrugging: `:woman_shrugging:`
:woman_singer: `:woman_singer:`
:woman_student: `:woman_student:`
:woman_teacher: `:woman_teacher:`
:woman_technologist: `:woman_technologist:`
:woman_with_headscarf: `:woman_with_headscarf:`
:woman_with_probing_cane: `:woman_with_probing_cane:`
:woman_with_turban: `:woman_with_turban:`
:woman_with_veil: `:woman_with_veil:`
:womans_clothes: `:womans_clothes:`
:womans_hat: `:womans_hat:`
:women_wrestling: `:women_wrestling:`
:womens: `:womens:`
:wood: `:wood:`
:woozy_face: `:woozy_face:`
:world_map: `:world_map:`
:worm: `:worm:`
:worried: `:worried:`
:wrench: `:wrench:`
:wrestling: `:wrestling:`
:writing_hand: `:writing_hand:`
:x: `:x:`
:x_ray: `:x_ray:`
:yarn: `:yarn:`
:yawning_face: `:yawning_face:`
:yellow_circle: `:yellow_circle:`
:yellow_heart: `:yellow_heart:`
:yellow_square: `:yellow_square:`
:yemen: `:yemen:`
:yen: `:yen:`
:yin_yang: `:yin_yang:`
:yo_yo: `:yo_yo:`
:yum: `:yum:`
:zambia: `:zambia:`
:zany_face: `:zany_face:`
:zap: `:zap:`
:zebra: `:zebra:`
:zero: `:zero:`
:zimbabwe: `:zimbabwe:`
:zipper_mouth_face: `:zipper_mouth_face:`
:zombie: `:zombie:`
:zombie_man: `:zombie_man:`
:zombie_woman: `:zombie_woman:`
:zzz: `:zzz:`
<!-- END: Auto-generated content (/build/emoji.js) -->
</div>
================================================
FILE: docs/helpers.md
================================================
# Doc helper
docsify extends Markdown syntax to make your documents more readable.
> Note: For the special code syntax cases, it's better to put them within code backticks to avoid any conflict from configurations or emojis.
## Callouts
Docsify supports [GitHub style](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) callouts (also known as "admonitions" or "alerts").
<!-- prettier-ignore -->
> [!CAUTION]
> **Caution** callouts communicate negative potential consequences of an action.
<!-- prettier-ignore -->
> [!IMPORTANT]
> **Important** callouts communicate information necessary for users to succeed.
<!-- prettier-ignore -->
> [!NOTE]
> **Note** callouts communicate information that users should take into account.
<!-- prettier-ignore -->
> [!TIP]
> **Tip** callouts communicate optional information to help a user be more successful.
<!-- prettier-ignore -->
> [!WARNING]
> **Warning** callouts communicate potential risks user should be aware of.
**Markdown**
<!-- prettier-ignore -->
```markdown
> [!CAUTION]
> **Caution** callouts communicate negative potential consequences of an action.
> [!IMPORTANT]
> **Important** callouts communicate information necessary for users to succeed.
> [!NOTE]
> **Note** callouts communicate information that users should take into account.
> [!TIP]
> **Tip** callouts communicate optional information to help a user be more successful.
> [!WARNING]
> **Warning** callouts communicate potential risks user should be aware of.
```
### Legacy Style ⚠️
The following Docsify v4 callout syntax has been deprecated and will be removed in a future version.
!> Legacy **Important** callouts are deprecated.
?> Legacy **Tip** callouts are deprecated.
**Markdown**
```markdown
!> Legacy **Important** callouts are deprecated.
?> Legacy **Tip** callouts are deprecated.
```
## Link attributes
### disabled
```markdown
[link](/demo ':disabled')
```
### href
Sometimes we will use some other relative path for the link, and we have to tell docsify that we don't need to compile this link. For example:
```markdown
[link](/demo/)
```
It will be compiled to `<a href="/#/demo/">link</a>` and will load `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
Now you can do that
```markdown
[link](/demo/ ':ignore')
```
You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set the title for the link.
```markdown
[link](/demo/ ':ignore title')
<a href="/demo/" title="title">link</a>
```
### target
```markdown
[link](/demo ':target=_blank')
[link](/demo2 ':target=_self')
```
## Task lists
```markdown
- [ ] foo
- bar
- [x] baz
- [] bam <~ not working
- [ ] bim
- [ ] lim
```
- [ ] foo
- bar
- [x] baz
- [] bam <~ not working
- [ ] bim
- [ ] lim
## Images
### Class names
```markdown
<!-- Multiple class names -->
```
### IDs
```markdown
```
### Sizes
```markdown
<!-- Support percentage -->
```
## Heading IDs
```markdown
### Hello, world! :id=hello-world
```
## Markdown + HTML
You need to insert a space between the html and markdown content.
This is useful for rendering markdown content in the details element.
```markdown
<details>
<summary>Self-assessment (Click to expand)</summary>
- Abc
- Abc
</details>
```
<details>
<summary>Self-assessment (Click to expand)</summary>
- Abc
- Abc
</details>
Markdown content can also be wrapped in html tags.
```markdown
<div style='color: red'>
- listitem
- listitem
- listitem
</div>
```
<div style='color: red'>
- listitem
- listitem
- listitem
</div>
================================================
FILE: docs/index.html
================================================
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>docsify
### Sponsors
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
================================================
FILE: Dockerfile
================================================
FROM mcr.microsoft.com/playwright:focal
WORKDIR /app
COPY . .
RUN rm package-lock.json
RUN npm install
RUN npx playwright install
RUN npm run build
ENTRYPOINT ["npm", "run"]
CMD ["test"]
================================================
FILE: HISTORY.md
================================================
## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
### Bug Fixes
* **render:** find => filter ([eca3368](https://github.com/QingWei-Li/docsify/commit/eca3368))
## [3.7.2](https://github.com/QingWei-Li/docsify/compare/v3.7.1...v3.7.2) (2017-05-19)
## [3.7.1](https://github.com/QingWei-Li/docsify/compare/v3.7.0...v3.7.1) (2017-05-19)
### Bug Fixes
* docsify-updated is undefined ([b2b4742](https://github.com/QingWei-Li/docsify/commit/b2b4742))
# [3.7.0](https://github.com/QingWei-Li/docsify/compare/v3.6.6...v3.7.0) (2017-05-16)
### Features
* add docsify-updated, close [#158](https://github.com/QingWei-Li/docsify/issues/158) ([d2be5ae](https://github.com/QingWei-Li/docsify/commit/d2be5ae))
* add externalLinkTarget, close [#149](https://github.com/QingWei-Li/docsify/issues/149) ([2d73285](https://github.com/QingWei-Li/docsify/commit/2d73285))
## [3.6.6](https://github.com/QingWei-Li/docsify/compare/v3.6.5...v3.6.6) (2017-05-06)
### Features
* support query string for the search, fixed [#156](https://github.com/QingWei-Li/docsify/issues/156) ([da75d70](https://github.com/QingWei-Li/docsify/commit/da75d70))
## [3.6.5](https://github.com/QingWei-Li/docsify/compare/v3.6.4...v3.6.5) (2017-04-28)
### Bug Fixes
* **util:** fix crash, fixed [#154](https://github.com/QingWei-Li/docsify/issues/154) ([51832d3](https://github.com/QingWei-Li/docsify/commit/51832d3))
## [3.6.4](https://github.com/QingWei-Li/docsify/compare/v3.6.3...v3.6.4) (2017-04-28)
### Bug Fixes
* **util:** correctly clean up duplicate slashes, fixed [#153](https://github.com/QingWei-Li/docsify/issues/153) ([76c041a](https://github.com/QingWei-Li/docsify/commit/76c041a))
## [3.6.3](https://github.com/QingWei-Li/docsify/compare/v3.6.2...v3.6.3) (2017-04-25)
### Bug Fixes
* **external-script:** script attrs ([2653849](https://github.com/QingWei-Li/docsify/commit/2653849))
## [3.6.2](https://github.com/QingWei-Li/docsify/compare/v3.6.0...v3.6.2) (2017-04-12)
### Features
* **event:** Collapse the sidebar when click outside element in the small screen ([9b7e5f5](https://github.com/QingWei-Li/docsify/commit/9b7e5f5))
* **external-script:** detect more than one script dom, fixed [#146](https://github.com/QingWei-Li/docsify/issues/146) ([94d6603](https://github.com/QingWei-Li/docsify/commit/94d6603))
# [3.6.0](https://github.com/QingWei-Li/docsify/compare/v3.5.2...v3.6.0) (2017-04-09)
### Features
* **render:** add mergeNavbar option, close [#125](https://github.com/QingWei-Li/docsify/issues/125), [#124](https://github.com/QingWei-Li/docsify/issues/124) ([#145](https://github.com/QingWei-Li/docsify/issues/145)) ([9220523](https://github.com/QingWei-Li/docsify/commit/9220523))
## [3.5.2](https://github.com/QingWei-Li/docsify/compare/v3.5.1...v3.5.2) (2017-04-05)
## [3.5.1](https://github.com/QingWei-Li/docsify/compare/v3.5.0...v3.5.1) (2017-03-25)
### Bug Fixes
* .md file extension regex ([594299f](https://github.com/QingWei-Li/docsify/commit/594299f))
# [3.5.0](https://github.com/QingWei-Li/docsify/compare/v3.4.4...v3.5.0) (2017-03-25)
### Bug Fixes
* adjust display on small screens ([bf35471](https://github.com/QingWei-Li/docsify/commit/bf35471))
* navbar labels for German ([b022aaf](https://github.com/QingWei-Li/docsify/commit/b022aaf))
### Features
* **route:** auto remove .md extension ([8f11653](https://github.com/QingWei-Li/docsify/commit/8f11653))
## [3.4.4](https://github.com/QingWei-Li/docsify/compare/v3.4.3...v3.4.4) (2017-03-17)
### Bug Fixes
* **search:** fix input style ([2d6a51b](https://github.com/QingWei-Li/docsify/commit/2d6a51b))
## [3.4.3](https://github.com/QingWei-Li/docsify/compare/v3.4.2...v3.4.3) (2017-03-16)
## [3.4.2](https://github.com/QingWei-Li/docsify/compare/v3.4.1...v3.4.2) (2017-03-11)
### Features
* **emojify:** add no-emoji option ([3aef37a](https://github.com/QingWei-Li/docsify/commit/3aef37a))
## [3.4.1](https://github.com/QingWei-Li/docsify/compare/v3.4.0...v3.4.1) (2017-03-10)
### Bug Fixes
* **dom:** Disable the dom cache when vue is present, fixed [#119](https://github.com/QingWei-Li/docsify/issues/119) ([b9a7275](https://github.com/QingWei-Li/docsify/commit/b9a7275))
# [3.4.0](https://github.com/QingWei-Li/docsify/compare/v3.3.0...v3.4.0) (2017-03-09)
### Features
* **zoom-image:** add plugin ([50fa6fc](https://github.com/QingWei-Li/docsify/commit/50fa6fc))
# [3.3.0](https://github.com/QingWei-Li/docsify/compare/v3.2.0...v3.3.0) (2017-03-07)
# [3.2.0](https://github.com/QingWei-Li/docsify/compare/v3.1.2...v3.2.0) (2017-02-28)
### Bug Fixes
* **fetch:** load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100) ([f3fc596](https://github.com/QingWei-Li/docsify/commit/f3fc596))
* **render:** Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106) ([0d59ee9](https://github.com/QingWei-Li/docsify/commit/0d59ee9))
### Features
* **search:** Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103) ([d3c9fbd](https://github.com/QingWei-Li/docsify/commit/d3c9fbd))
## [3.1.2](https://github.com/QingWei-Li/docsify/compare/v3.1.1...v3.1.2) (2017-02-27)
## [3.1.1](https://github.com/QingWei-Li/docsify/compare/v3.1.0...v3.1.1) (2017-02-24)
### Bug Fixes
* **render:** custom cover background image ([8f9bf29](https://github.com/QingWei-Li/docsify/commit/8f9bf29))
* **search:** don't search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102) ([507d9e8](https://github.com/QingWei-Li/docsify/commit/507d9e8))
* **tpl:** extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101) ([d67d25f](https://github.com/QingWei-Li/docsify/commit/d67d25f))
# [3.1.0](https://github.com/QingWei-Li/docsify/compare/v3.0.5...v3.1.0) (2017-02-22)
### Bug Fixes
* **search:** incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90) ([b8a3d8f](https://github.com/QingWei-Li/docsify/commit/b8a3d8f))
* **sw:** update white list ([f2975a5](https://github.com/QingWei-Li/docsify/commit/f2975a5))
### Features
* **emoji:** add emoji plugin ([855c450](https://github.com/QingWei-Li/docsify/commit/855c450))
## [3.0.5](https://github.com/QingWei-Li/docsify/compare/v3.0.4...v3.0.5) (2017-02-21)
### Bug Fixes
* **event:** highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86) ([2a1157a](https://github.com/QingWei-Li/docsify/commit/2a1157a))
* **gen-tree:** cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88) ([3394ebb](https://github.com/QingWei-Li/docsify/commit/3394ebb))
* **layout.css:** loading style ([42b2dba](https://github.com/QingWei-Li/docsify/commit/42b2dba))
### Features
* **pwa:** add sw.js ([f7111b5](https://github.com/QingWei-Li/docsify/commit/f7111b5))
## [3.0.4](https://github.com/QingWei-Li/docsify/compare/v3.0.3...v3.0.4) (2017-02-20)
### Bug Fixes
* **render:** disable rendering sub list when loadSidebar is false ([35dd2e1](https://github.com/QingWei-Li/docsify/commit/35dd2e1))
* **render:** execute script ([780c1e5](https://github.com/QingWei-Li/docsify/commit/780c1e5))
## [3.0.3](https://github.com/QingWei-Li/docsify/compare/v3.0.2...v3.0.3) (2017-02-19)
## [3.0.2](https://github.com/QingWei-Li/docsify/compare/v3.0.1...v3.0.2) (2017-02-19)
### Bug Fixes
* **compiler:** link ([3b127a1](https://github.com/QingWei-Li/docsify/commit/3b127a1))
* **search:** add lazy input ([bf593a7](https://github.com/QingWei-Li/docsify/commit/bf593a7))
## [3.0.1](https://github.com/QingWei-Li/docsify/compare/v3.0.0...v3.0.1) (2017-02-19)
### Bug Fixes
* **route:** empty alias ([cd99b52](https://github.com/QingWei-Li/docsify/commit/cd99b52))
# [3.0.0](https://github.com/QingWei-Li/docsify/compare/v2.4.3...v3.0.0) (2017-02-19)
### Bug Fixes
* **compiler:** link ([c7e09c3](https://github.com/QingWei-Li/docsify/commit/c7e09c3))
* **render:** support html file ([7b6a2ac](https://github.com/QingWei-Li/docsify/commit/7b6a2ac))
* **search:** escape html ([fcb66e8](https://github.com/QingWei-Li/docsify/commit/fcb66e8))
* **search:** fix default config ([2efd859](https://github.com/QingWei-Li/docsify/commit/2efd859))
### Features
* **front-matter:** add front matter[WIP] ([dbb9278](https://github.com/QingWei-Li/docsify/commit/dbb9278))
* **render:** add auto header ([b7768b1](https://github.com/QingWei-Li/docsify/commit/b7768b1))
* **search:** Localization for search placeholder, close [#80](https://github.com/QingWei-Li/docsify/issues/80) ([2351c3e](https://github.com/QingWei-Li/docsify/commit/2351c3e))
* **themes:** add loading info ([86594a3](https://github.com/QingWei-Li/docsify/commit/86594a3))
## [2.4.3](https://github.com/QingWei-Li/docsify/compare/v2.4.2...v2.4.3) (2017-02-15)
## [2.4.2](https://github.com/QingWei-Li/docsify/compare/v2.4.1...v2.4.2) (2017-02-14)
### Bug Fixes
* **index:** load file path error ([dc536a3](https://github.com/QingWei-Li/docsify/commit/dc536a3))
## [2.4.1](https://github.com/QingWei-Li/docsify/compare/v2.4.0...v2.4.1) (2017-02-13)
### Bug Fixes
* **index:** cover page ([dd0c84b](https://github.com/QingWei-Li/docsify/commit/dd0c84b))
# [2.4.0](https://github.com/QingWei-Li/docsify/compare/v2.3.0...v2.4.0) (2017-02-13)
### Features
* **hook:** add doneEach ([c6f7602](https://github.com/QingWei-Li/docsify/commit/c6f7602))
# [2.3.0](https://github.com/QingWei-Li/docsify/compare/v2.2.1...v2.3.0) (2017-02-13)
### Bug Fixes
* **event:** has no effect on a FF mobile browser, fixed [#67](https://github.com/QingWei-Li/docsify/issues/67) ([0ff36c2](https://github.com/QingWei-Li/docsify/commit/0ff36c2))
* **render:** custom marked renderer ([bf559b4](https://github.com/QingWei-Li/docsify/commit/bf559b4))
* **render:** fix render link ([a866744](https://github.com/QingWei-Li/docsify/commit/a866744))
* **render:** image url ([6f87529](https://github.com/QingWei-Li/docsify/commit/6f87529))
* **render:** render link ([38ea660](https://github.com/QingWei-Li/docsify/commit/38ea660))
* **src:** fix route ([324301a](https://github.com/QingWei-Li/docsify/commit/324301a))
* **src:** get alias ([784173e](https://github.com/QingWei-Li/docsify/commit/784173e))
* **src:** get alias ([ce99a04](https://github.com/QingWei-Li/docsify/commit/ce99a04))
* **themes:** fix navbar style ([fa54b52](https://github.com/QingWei-Li/docsify/commit/fa54b52))
* **themes:** update navbar style ([4864d1b](https://github.com/QingWei-Li/docsify/commit/4864d1b))
### Features
* **hook:** support custom plugin ([9e81a59](https://github.com/QingWei-Li/docsify/commit/9e81a59))
* **src:** add alias feature ([24412cd](https://github.com/QingWei-Li/docsify/commit/24412cd))
* **src:** dynamic title and fix sidebar style ([6b30eb6](https://github.com/QingWei-Li/docsify/commit/6b30eb6))
## [2.2.1](https://github.com/QingWei-Li/docsify/compare/v2.2.0...v2.2.1) (2017-02-11)
### Bug Fixes
* **event:** scroll active sidebar ([50f5fc2](https://github.com/QingWei-Li/docsify/commit/50f5fc2))
* **search:** crash when not content, fixed [#68](https://github.com/QingWei-Li/docsify/issues/68) ([9d3cc89](https://github.com/QingWei-Li/docsify/commit/9d3cc89))
* **search:** not work in mobile ([3941304](https://github.com/QingWei-Li/docsify/commit/3941304))
# [2.2.0](https://github.com/QingWei-Li/docsify/compare/v2.1.0...v2.2.0) (2017-02-09)
### Features
* **plugins:** add Google Analytics plugin ([#66](https://github.com/QingWei-Li/docsify/issues/66)) ([ac61bb0](https://github.com/QingWei-Li/docsify/commit/ac61bb0))
# [2.1.0](https://github.com/QingWei-Li/docsify/compare/v2.0.3...v2.1.0) (2017-02-09)
### Bug Fixes
* render name ([12e2479](https://github.com/QingWei-Li/docsify/commit/12e2479))
* **vue.css:** update sidebar style ([fc140ef](https://github.com/QingWei-Li/docsify/commit/fc140ef))
### Features
* add search, close [#43](https://github.com/QingWei-Li/docsify/issues/43) ([eb5ff3e](https://github.com/QingWei-Li/docsify/commit/eb5ff3e))
## [2.0.3](https://github.com/QingWei-Li/docsify/compare/v2.0.2...v2.0.3) (2017-02-07)
### Bug Fixes
* css var polyfill ([8cd386a](https://github.com/QingWei-Li/docsify/commit/8cd386a))
* css var polyfill ([cbaee21](https://github.com/QingWei-Li/docsify/commit/cbaee21))
* rendering emojis ([8c7e4d7](https://github.com/QingWei-Li/docsify/commit/8c7e4d7))
## [2.0.2](https://github.com/QingWei-Li/docsify/compare/v2.0.1...v2.0.2) (2017-02-05)
### Bug Fixes
* button style in cover page ([4470855](https://github.com/QingWei-Li/docsify/commit/4470855))
## [2.0.1](https://github.com/QingWei-Li/docsify/compare/v2.0.0...v2.0.1) (2017-02-05)
# [2.0.0](https://github.com/QingWei-Li/docsify/compare/v1.10.5...v2.0.0) (2017-02-05)
### Features
* customize the theme color ([5cc9f05](https://github.com/QingWei-Li/docsify/commit/5cc9f05))
## [1.10.5](https://github.com/QingWei-Li/docsify/compare/v1.10.4...v1.10.5) (2017-01-28)
## [1.10.4](https://github.com/QingWei-Li/docsify/compare/v1.10.3...v1.10.4) (2017-01-27)
## [1.10.3](https://github.com/QingWei-Li/docsify/compare/v1.10.2...v1.10.3) (2017-01-27)
## [1.10.2](https://github.com/QingWei-Li/docsify/compare/v1.10.1...v1.10.2) (2017-01-25)
## [1.10.1](https://github.com/QingWei-Li/docsify/compare/v1.10.0...v1.10.1) (2017-01-25)
# [1.10.0](https://github.com/QingWei-Li/docsify/compare/v1.9.0...v1.10.0) (2017-01-25)
# [1.9.0](https://github.com/QingWei-Li/docsify/compare/v1.8.0...v1.9.0) (2017-01-24)
# [1.8.0](https://github.com/QingWei-Li/docsify/compare/v1.7.4...v1.8.0) (2017-01-24)
## [1.7.4](https://github.com/QingWei-Li/docsify/compare/v1.7.3...v1.7.4) (2017-01-13)
## [1.7.3](https://github.com/QingWei-Li/docsify/compare/v1.7.2...v1.7.3) (2017-01-13)
## [1.7.2](https://github.com/QingWei-Li/docsify/compare/v1.7.1...v1.7.2) (2017-01-12)
## [1.7.1](https://github.com/QingWei-Li/docsify/compare/v1.7.0...v1.7.1) (2017-01-12)
# [1.7.0](https://github.com/QingWei-Li/docsify/compare/v1.6.1...v1.7.0) (2017-01-12)
## [1.6.1](https://github.com/QingWei-Li/docsify/compare/v1.6.0...v1.6.1) (2017-01-10)
# [1.6.0](https://github.com/QingWei-Li/docsify/compare/v1.5.2...v1.6.0) (2017-01-10)
## [1.5.2](https://github.com/QingWei-Li/docsify/compare/v1.5.1...v1.5.2) (2017-01-10)
## [1.5.1](https://github.com/QingWei-Li/docsify/compare/v1.5.0...v1.5.1) (2017-01-09)
# [1.5.0](https://github.com/QingWei-Li/docsify/compare/v1.4.3...v1.5.0) (2017-01-04)
### Features
* Markdown parser is configurable, [#42](https://github.com/QingWei-Li/docsify/issues/42) ([8b1000a](https://github.com/QingWei-Li/docsify/commit/8b1000a))
## [1.4.3](https://github.com/QingWei-Li/docsify/compare/v1.4.2...v1.4.3) (2017-01-01)
## [1.4.2](https://github.com/QingWei-Li/docsify/compare/v1.4.1...v1.4.2) (2016-12-31)
## [1.4.1](https://github.com/QingWei-Li/docsify/compare/v1.4.0...v1.4.1) (2016-12-31)
# [1.4.0](https://github.com/QingWei-Li/docsify/compare/v1.3.5...v1.4.0) (2016-12-31)
## [1.3.5](https://github.com/QingWei-Li/docsify/compare/v1.3.4...v1.3.5) (2016-12-25)
## [1.3.4](https://github.com/QingWei-Li/docsify/compare/v1.3.3...v1.3.4) (2016-12-25)
## [1.3.3](https://github.com/QingWei-Li/docsify/compare/v1.3.2...v1.3.3) (2016-12-23)
## [1.3.2](https://github.com/QingWei-Li/docsify/compare/v1.3.1...v1.3.2) (2016-12-22)
## [1.3.1](https://github.com/QingWei-Li/docsify/compare/v1.3.0...v1.3.1) (2016-12-22)
# [1.3.0](https://github.com/QingWei-Li/docsify/compare/v1.2.0...v1.3.0) (2016-12-21)
# [1.2.0](https://github.com/QingWei-Li/docsify/compare/v1.1.7...v1.2.0) (2016-12-20)
## [1.1.7](https://github.com/QingWei-Li/docsify/compare/v1.1.6...v1.1.7) (2016-12-19)
## [1.1.6](https://github.com/QingWei-Li/docsify/compare/v1.1.5...v1.1.6) (2016-12-18)
## [1.1.5](https://github.com/QingWei-Li/docsify/compare/v1.1.4...v1.1.5) (2016-12-18)
## [1.1.4](https://github.com/QingWei-Li/docsify/compare/v1.1.3...v1.1.4) (2016-12-17)
## [1.1.3](https://github.com/QingWei-Li/docsify/compare/v1.1.2...v1.1.3) (2016-12-17)
## [1.1.2](https://github.com/QingWei-Li/docsify/compare/v1.1.1...v1.1.2) (2016-12-17)
## [1.1.1](https://github.com/QingWei-Li/docsify/compare/v1.1.0...v1.1.1) (2016-12-17)
# [1.1.0](https://github.com/QingWei-Li/docsify/compare/v1.0.3...v1.1.0) (2016-12-16)
## [1.0.3](https://github.com/QingWei-Li/docsify/compare/v1.0.2...v1.0.3) (2016-12-13)
## [1.0.2](https://github.com/QingWei-Li/docsify/compare/v1.0.1...v1.0.2) (2016-12-13)
## [1.0.1](https://github.com/QingWei-Li/docsify/compare/v1.0.0...v1.0.1) (2016-12-08)
# [1.0.0](https://github.com/QingWei-Li/docsify/compare/v0.7.0...v1.0.0) (2016-12-08)
# [0.7.0](https://github.com/QingWei-Li/docsify/compare/v0.6.1...v0.7.0) (2016-11-30)
## [0.6.1](https://github.com/QingWei-Li/docsify/compare/v0.6.0...v0.6.1) (2016-11-29)
# [0.6.0](https://github.com/QingWei-Li/docsify/compare/v0.5.0...v0.6.0) (2016-11-29)
# [0.5.0](https://github.com/QingWei-Li/docsify/compare/v0.4.2...v0.5.0) (2016-11-28)
## [0.4.2](https://github.com/QingWei-Li/docsify/compare/v0.4.1...v0.4.2) (2016-11-28)
## [0.4.1](https://github.com/QingWei-Li/docsify/compare/v0.4.0...v0.4.1) (2016-11-28)
# [0.4.0](https://github.com/QingWei-Li/docsify/compare/v0.3.1...v0.4.0) (2016-11-27)
### Features
* custom sidebar, [#4](https://github.com/QingWei-Li/docsify/issues/4) ([#5](https://github.com/QingWei-Li/docsify/issues/5)) ([37e7984](https://github.com/QingWei-Li/docsify/commit/37e7984))
## [0.3.1](https://github.com/QingWei-Li/docsify/compare/v0.3.0...v0.3.1) (2016-11-27)
# [0.3.0](https://github.com/QingWei-Li/docsify/compare/v0.2.1...v0.3.0) (2016-11-27)
## [0.2.1](https://github.com/QingWei-Li/docsify/compare/v0.2.0...v0.2.1) (2016-11-26)
# [0.2.0](https://github.com/QingWei-Li/docsify/compare/v0.1.0...v0.2.0) (2016-11-26)
# [0.1.0](https://github.com/QingWei-Li/docsify/compare/v0.0.5...v0.1.0) (2016-11-26)
## [0.0.5](https://github.com/QingWei-Li/docsify/compare/v0.0.4...v0.0.5) (2016-11-24)
## [0.0.4](https://github.com/QingWei-Li/docsify/compare/v0.0.3...v0.0.4) (2016-11-22)
## [0.0.3](https://github.com/QingWei-Li/docsify/compare/v0.0.2...v0.0.3) (2016-11-20)
## [0.0.2](https://github.com/QingWei-Li/docsify/compare/v0.0.1...v0.0.2) (2016-11-20)
## 0.0.1 (2016-11-20)
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) 2016 - present Docsify Contributors (https://github.com/docsifyjs/docsify/graphs/contributors)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].