# gitbook-plugin-ace

> Ace, code editor plugin for GitBook

Latest version **0.3.2** (published 2016-08-24) · GPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install gitbook-plugin-ace
pnpm add gitbook-plugin-ace
yarn add gitbook-plugin-ace
bun add gitbook-plugin-ace
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2016-08-24 |
| First published | 2015-08-10 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | ymcatar |

## Links

- npm: https://www.npmjs.com/package/gitbook-plugin-ace
- Repository: https://github.com/ymcatar/gitbook-plugin-ace
- Issues: https://github.com/ymcatar/gitbook-plugin-ace/issues
- npm.io page: https://npm.io/package/gitbook-plugin-ace

## Dependencies (2)

- [html-escape](https://npm.io/package/html-escape.md) ^1.0.2
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.3.0

## Recent versions

- 0.3.2 (latest) — 2016-08-24
- 0.3.1 — 2016-08-16
- 0.3.0 — 2016-08-09
- 0.2.1 — 2016-04-15
- 0.2.0 — 2016-04-15
- 0.1.2 — 2016-01-30
- 0.1.1 — 2016-01-30
- 0.1.0 — 2015-12-23
- 0.0.5 — 2015-12-18
- 0.0.4 — 2015-11-16
- 0.0.3 — 2015-09-29
- 0.0.2 — 2015-08-11
- 0.0.1 — 2015-08-10

## README

GitBook Ace Plugin
===

This is a code editor plugin for GitBook, for inserting code segments into the book, with syntax highlight supports for about 110 types of programming languages.

See the plugin at work [here](http://ymcatar.gitbooks.io/gitbook-test/content/testing_ace.html).

## Changelog

* 0.3 Releases:
    * **0.3.2**: Fixed issue with code like `{{something}}` (angular expression)
    * **0.3.1**: Updated regular expression to better detect {%ace%} tags.
    * **0.3.0**: (Requires gitbook 3.0 or up) Improved support for gitbook 3.0+.


* 0.2 Releases:
    * **0.2.1**: Default to 'c_cpp' for pdf syntax highlight if language is not specified.
    * **0.2.0**: Added experimental support for pdf syntax highlight, please open issues for languages that are not working for you.


* 0.1 Releases:
    * **0.1.2**: Removed dark theme logic, fix theme error.
    * **0.1.1**: Added custom theme parameter.
    * **0.1.0**: Updated to latest version of ace (added Swift and JSX syntax support).


* 0.0 Releases:
    * **0.0.5**: Include pull requests from github, fixing scrolling.
    * **0.0.4**: Fixed syntax error in code.
    * **0.0.3**: Added option to disable syntax validation.
    * **0.0.2**: Added .pdf, .epub, .emobi format export support.
    * **0.0.1**: Initial release.

## Syntax

The plugin has a basic syntax:

```
{%ace edit=true, lang='c_cpp'%}
// This is a hello world program for C.
#include <stdio.h>

int main(){
  printf("Hello World!");
  return 1;
}
{%endace%}
```

* ```edit```: if this is set to true, the code will be editable by the user.

* ```lang```: the language for syntax highlight. If this is not specified, it will fallback to 'c_cpp' by default. For the full list of keyword for each language, please check out the github page of ace [here](https://github.com/ajaxorg/ace-builds/tree/master/src-min-noconflict), all the related files are starting with prefix ```mode-```. For instance:
    * mode_c_cpp.js ----> c_cpp
    * mode_java.js ----> java
    * ...

* ```check```: if this is set to false, syntax validation will be disabled.

* ```theme```: the theme for the editor, the default is 'chrome'.
    * monokai
    * coffee
    * ...

---
_Source: https://npm.io/package/gitbook-plugin-ace · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._