Skip to content

Document the Ace Editor #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Michael-F-Bryan opened this issue Jan 3, 2018 · 0 comments
Closed

Document the Ace Editor #521

Michael-F-Bryan opened this issue Jan 3, 2018 · 0 comments
Labels
A-Documentation Area: Documentation E-Easy Experience: Easy

Comments

@Michael-F-Bryan
Copy link
Contributor

#338 added the ace editor but we didn't really document it in the user guide. There are currently two parts to making code snippets editable, first you need to enable editing in your book.toml, then you need to add an editable annotation to your code blocks.

The config file:

[output.html.playpen]
editor = "./path/to/ace/editor"  # defaults to using the ace editor
editable = false # defaults to false

Making a specific code snippet editable

```rust,editable
use std::fs::File;
File::open("foo.txt").unwrap();
```
@Michael-F-Bryan Michael-F-Bryan added A-Documentation Area: Documentation E-Easy Experience: Easy labels Jan 7, 2018
projektir added a commit to projektir/mdBook that referenced this issue Jan 17, 2018
Michael-F-Bryan added a commit that referenced this issue Jan 17, 2018
Ruin0x11 pushed a commit to Ruin0x11/mdBook that referenced this issue Aug 30, 2020
Ruin0x11 pushed a commit to Ruin0x11/mdBook that referenced this issue Aug 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Documentation Area: Documentation E-Easy Experience: Easy
Projects
None yet
Development

No branches or pull requests

1 participant