gitbook_multilanguage_template
  • README
  • LANGS
  • README
    • gitbook_markdown
    • GitBook 多语言模板
    • 目录
    • GitBook && GitHub
  • node_modules
    • Mermaid plugin for GitBook
      • node_modules
        • README
          • node_modules
            • README
              • Changelog
            • mkdirp
              • readme
              • node_modules
                • minimist
                  • readme
            • chalk
              • node_modules
                • has-ansi
                  • node_modules
                    • ansi-regex
                      • ansi-regex
                  • has-ansi
                • ansi-styles
                  • ansi-styles
                • strip-ansi
                  • node_modules
                    • ansi-regex
                      • ansi-regex
                  • strip-ansi
                • escape-string-regexp
                  • escape-string-regexp
                • supports-color
                  • supports-color
              • readme
            • he
            • which
              • node_modules
                • is-absolute
                  • node_modules
                    • is-relative
                • isexe
            • dagre - Graph layout for JavaScript
              • node_modules
                • lodash v3.10.1
                • README
            • dagre-d3 - A D3-based renderer for dagre
              • node_modules
                • lodash v3.10.1
                • README
            • semver(1) -- The semantic versioner for npm
            • minimist
              • readme
            • Data-Driven Documents
              • Contributing
          • build
            • content
              • usage
              • Development
              • Upgrading to from version -0.4.0
              • Gant diagrams
              • Sequence diagrams
              • index
              • Flowcharts - Basic Syntax
              • Demos
              • mermaid CLI
              • mermaidAPI
          • docs
            • content
              • mermaid CLI
              • usage
              • Development
              • Upgrading to from version -0.4.0
              • Gant diagrams
              • index
              • Sequence diagrams
              • Flowcharts - Basic Syntax
              • Demos
          • Change Log
          • CONTRIBUTING
          • src
            • diagrams
              • gantt
                • exGantt
    • gitbook-plugin-todo
      • node_modules
        • cheerio
          • CONTRIBUTING
          • node_modules
            • htmlparser2
              • node_modules
                • domhandler
                  • DOMHandler
                • domutils
                  • readme
                • readable-stream
                  • node_modules
                    • core-util-is
                    • isarray
                    • README
                    • README
                • domelementtype
                  • readme
                • entities
                  • entities
            • lodash v3.10.1
            • css-select
              • node_modules
                • domutils
                  • node_modules
                    • domelementtype
                      • readme
                  • readme
                • boolbase
                • css-what
                  • css-what
                • nth-check
            • entities
              • entities
            • dom-serializer
              • node_modules
                • domelementtype
                  • readme
          • History
          • cheerio
        • README
    • gitbook-plugin-toc
      • node_modules
        • marked-toc
          • node_modules
            • Uslug.js
              • node_modules
                • README
                  • LICENSE
            • template
              • node_modules
                • fs-utils
                  • node_modules
                    • JS-YAML - YAML 1.2 parser and serializer for JavaScript
                      • node_modules
                        • README
                          • node_modules
                            • underscore.string
                              • Underscore.string #
                            • README
                          • HISTORY
                        • README
                      • HISTORY
                    • globule
                      • node_modules
                        • minimatch
                          • node_modules
                            • lru cache
                            • sigmund
                        • Glob
                          • node_modules
                            • minimatch
                              • node_modules
                                • lru cache
                                • sigmund
                            • README
                      • test
                        • fixtures
                          • README
                    • graceful-fs
                    • mkdirp
                      • readme
                    • Async.js
                    • README
                  • test
                    • fixtures
                      • foo
                • delims
                • underscore.string
                  • Underscore.string #
            • fs-utils
              • node_modules
                • JS-YAML - YAML 1.2 parser / writer for JavaScript
                  • node_modules
                    • README
                      • CHANGELOG
                      • node_modules
                        • README
                    • README
                  • CHANGELOG
                • delete
                  • node_modules
                    • README
                      • node_modules
                        • Glob
                          • node_modules
                            • inflight
                              • node_modules
                                • wrappy
                            • minimatch
                              • node_modules
                                • brace-expansion
                                  • node_modules
                                    • balanced-match
                                      • LICENSE
                                    • concat-map
                                      • README
                            • README
                            • once
                              • node_modules
                                • wrappy
                            • path-is-absolute
                              • path-is-absolute
                          • changelog
                    • is-path-in-cwd
                      • node_modules
                        • is-path-inside
                          • is-path-inside
                          • node_modules
                            • Is This Path Inside This Other Path?
                      • is-path-in-cwd
                    • is-path-cwd
                      • is-path-cwd
                  • {%= name %} {%= badge("fury") %}
                • is-absolute
                  • node_modules
                    • is-relative
                • globby
                  • node_modules
                    • README
                      • node_modules
                        • once
                          • node_modules
                            • wrappy
                        • minimatch
                          • node_modules
                            • brace-expansion
                              • node_modules
                                • balanced-match
                                  • LICENSE
                                • concat-map
                                  • README
                        • inflight
                          • node_modules
                            • wrappy
                        • README
                    • array-union
                      • node_modules
                        • array-uniq
                          • array-uniq
                      • array-union
                    • array-differ
                      • array-differ
                  • globby
                • Async.js
                • kind-of
                  • {%= name %} {%= badge("fury") %}
                • extend-shallow
                  • node_modules
                    • array-slice
                  • {%= name %} {%= badge("fury") %}
                • relative
                  • {%= name %} {%= badge("fury") %}
                  • node_modules
                    • normalize-path
                      • {%= name %} {%= badge("fury") %}
                • graceful-fs
              • test
                • fixtures
                  • foo
              • {%= name %} {%= badge("fury") %}
            • gray-matter
              • test
                • fixtures
                  • autodetect-javascript
                  • autodetect-no-lang
                  • This page has JSON front matter!
                  • autodetect-coffee
                  • This page has YAML front matter!
                  • autodetect-json
                  • autodetect-yaml
                  • has-matter
                  • to-json
                  • delims-custom
                  • lang-toml
                  • to-yaml
                  • autodetect-coffee-fn
                  • This file doesn't have matter!
                  • autodetect-toml
                  • autodetect-cson-fn
                  • delims-semi-colons
                  • lang-coffee-fn
                  • lang-javascript-fn
                  • complex
                  • lang-cson-fn
                  • This page has cson front matter!
                  • empty
                  • delims-and-lang
                  • This page has coffee front matter!
                  • autodetect-cson
              • {%= name %} {%= badge("fury") %}
              • node_modules
                • README
                  • node_modules
                    • arrayify-compact
                      • node_modules
                        • Array Flatten
                      • {%= name %} {%= badge("fury") %}
                    • object-pick
                • mixin-deep
                  • node_modules
                    • is-plain-object
                      • {%= name %} {%= badge("fury") %}
                    • for-own
                      • node_modules
                        • for-in
                  • {%= name %} {%= badge("fury") %}
                • verbalize
                  • node_modules
                    • chalk
                      • readme
                      • node_modules
                        • ansi-styles
                          • ansi-styles
                        • strip-ansi
                          • strip-ansi
                        • has-color
                          • has-color
                  • docs
                    • install
                    • {%= name %} {%= badge('fury') %}
                • JS-YAML - YAML 1.2 parser / writer for JavaScript
                  • node_modules
                    • README
                      • CHANGELOG
                      • node_modules
                        • README
                    • README
                  • CHANGELOG
                • TOML Parser for Node.js
                  • CHANGELOG
                • README
                  • How to contribute to CoffeeScript
              • docs
                • examples
                • why
                • options
            • marked
            • Lo-Dash v2.4.2
          • test
            • actual
              • Test
              • Handlebars-Helper
              • Related-Grunt-Tasks
              • Repos-List
              • Examples
              • Readme-Repos-List
              • toc
              • Foo
              • Readme3
              • Readme2
              • Readme-Repos
              • Readme1
              • Related-Repos
              • Badge-Mixins
              • Test
            • fixtures
              • repos-list
              • handlebars-helper
              • examples
              • related-grunt-tasks
              • grunt-readme
              • Contains toc stop comment
              • grunt-readme
              • Badges
              • Examples
              • marked-toc
              • Documentation
              • Test
              • grunt-readme
              • grunt-readme
              • Contains extra comment
              • related-repos
              • grunt-readme
    • GitBook Plugin: Advanced Emoji
      • node_modules
        • emojify.js
          • LICENSE
          • LICENSE-IMAGES
          • Contributing
      • assets
        • LICENSE-IMAGES
        • LICENSE
      • Howto Publish to npmjs.org
    • gitbook-plugin-chart
      • node_modules
        • JS-YAML - YAML 1.2 parser / writer for JavaScript
          • node_modules
            • README
            • README
              • CHANGELOG
              • node_modules
                • README
          • CHANGELOG
    • gitbook-plugin-search-pro
      • node_modules
        • README
          • node_modules
            • nan
              • doc
                • Scopes
                • Strings & Bytes
                • Maybe Types
                • New
                • Object Wrappers
                • V8 internals
                • Persistent references
                • Asynchronous work helpers
                • Converters
                • Buffers
                • JavaScript-accessible methods
                • Script
                • Errors
                • Nan::Callback
                • Miscellaneous V8 Helpers
                • Miscellaneous Node Helpers
              • The MIT License (MIT)
              • README
              • NAN ChangeLog
          • README_EN
          • NodeJieba ChangeLog
        • lodash v3.10.1
    • Math typesetting using KaTex
      • node_modules
        • README
          • node_modules
            • match-at
          • README
    • Emphasize texts in GitBook
    • Disqus integration for GitBook
  • README
    • GitBook 多言語対応テンプレート
    • GitBook && GitHub
    • カタログ
    • gitbook_markdown
  • README
    • GitBook && GitHub
    • Table of content
    • gitbook_markdown
    • GitBook Multilanguage Template
Powered by GitBook
On this page
  • Installation
  • Using Ignore Flags
  • Building a PDF
  • License

Was this helpful?

  1. node_modules

GitBook Plugin: Advanced Emoji

Previousgrunt-readmeNextnode_modules

Last updated 5 years ago

Was this helpful?

Transforms emojis like :white_check_mark: into real emoji images using .

Please note that this plugin only works for markdown files. All other filetypes will just be ignored, and the plugin does nothing.

Installation

You can install this plugin via npm:

$ npm install gitbook-plugin-advanced-emoji

Be sure to activate the option from the book.json file:

{
    "plugins" : ["advanced-emoji"]
}

Then run gitbook install followed by either gitbook serve or gitbook build

Using Ignore Flags

If you want for example occurences of emojis not replaced you will need to wrap them in the following comments.

<!-- ignore:advanced-emoji:start -->
:white_check_mark:
<!-- ignore:advanced-emoji:end -->

You can even set the ignores around a codeblock or more lines.

This is a text

<!-- ignore:advanced-emoji:start -->
'''
Check the Code
Code ... :white_check_mark:
'''
<!-- ignore:advanced-emoji:end -->

foo

Building a PDF

License

You can see the Branch on how to use the plugin when building a PDF.

is licensed under MIT License

is licensed under MIT License

pdf-test-book
https://github.com/codeclou/gitbook-plugin-advanced-emoji
https://github.com/hassankhan/emojify.js
emojify.js