Documenting the editor #521

This commit is contained in:
projektir 2018-01-16 21:26:13 -08:00
parent bf093e2f5f
commit 57f960a03b
4 changed files with 45 additions and 0 deletions

View File

@ -5,3 +5,6 @@ author = "Mathieu David"
[output.html] [output.html]
mathjax-support = true mathjax-support = true
[output.html.playpen]
editable = true

View File

@ -13,6 +13,7 @@
- [Theme](format/theme/theme.md) - [Theme](format/theme/theme.md)
- [index.hbs](format/theme/index-hbs.md) - [index.hbs](format/theme/index-hbs.md)
- [Syntax highlighting](format/theme/syntax-highlighting.md) - [Syntax highlighting](format/theme/syntax-highlighting.md)
- [Editor](format/theme/editor.md)
- [MathJax Support](format/mathjax.md) - [MathJax Support](format/mathjax.md)
- [Rust code specific features](format/rust.md) - [Rust code specific features](format/rust.md)
- [For Developers](lib/index.md) - [For Developers](lib/index.md)

View File

@ -0,0 +1,40 @@
# Editor
In addition to providing runnable code playpens, mdBook optionally allows them to be editable. In order to enable editable code blocks, the following needs to be added to the ***book.toml***:
```toml
[output.html.playpen]
editable = true
```
To make a specific block available for editing, the attribute `editable` needs to be added to it:
<pre><code class="language-markdown">```rust,editable
fn main() {
let number = 5;
print!("{}", number);
}
```</code></pre>
The above will result in this editable playpen:
```rust,editable
fn main() {
let number = 5;
print!("{}", number);
}
```
Note the new `Undo Changes` button in the editable playpens.
## Customizing the Editor
By default, the editor is the [Ace](https://ace.c9.io/) editor, but, if desired, the functionality may be overriden by providing a different folder:
```toml
[output.html.playpen]
editable = true
editor = "/path/to/editor"
```
Note that for the editor changes to function correctly, the `book.js` inside of the `theme` folder will need to be overriden as it has some couplings with the default Ace editor.

View File

@ -13,3 +13,4 @@ If you have contributed to mdBook and I forgot to add you, don't hesitate to add
- Fu Gangqiang ([FuGangqiang](https://github.com/FuGangqiang)) - Fu Gangqiang ([FuGangqiang](https://github.com/FuGangqiang))
- [Michael-F-Bryan](https://github.com/Michael-F-Bryan) - [Michael-F-Bryan](https://github.com/Michael-F-Bryan)
- [Chris Spiegel](https://github.com/cspiegel) - [Chris Spiegel](https://github.com/cspiegel)
- [projektir](https://github.com/projektir)