update the documentation for 0.1.0 release

[budziq]

we have to document all the new features and options in config
as well as non backwards compatible behaviour.

• clipboard support
• optional MathJax
• additional js
• additional css
• new theme (ayu)?
• Document the version pinning for CI in the README
• Document the {{# include }}
• the -L option
• editable playpens with ACE
• Update contributor list (or remove it?)
• ...

[azerupi]

I just noticed that "copy to clipboard" is only available for Rust snippets. I would make it available on any code snippet. I am documenting it like that and we should fix it before the 0.1 release :)

[budziq]

agreed. I've created an issue for it https://github.com/azerupi/mdBook/issues/432

…

On 11 Sep 2017 22:01, "Mathieu David" ***@***.***> wrote: I just noticed that "copy to clipboard" is only available for Rust snippets. I would make it available on any code snippet. I am documenting it like that and we should fix it before the 0.1 release :) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://github.com/azerupi/mdBook/issues/368#issuecomment-328642171>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AANfSMexeYwGC1MIyo4iZ6duHIuWak8-ks5shZGwgaJpZM4OH2D0> .

[azerupi]

Thanks :)
I am going through the whole user guide updating where we need. I think I might be able to finish the documentation tonight. If I still have sometime left I will do the clipboard issue too. After that we should be good for a 0.1 release! 🎉

[azerupi]

I can't get the Ace editor to work now, so I can't document it. I checked what I already covered in the documentation. I will push what I have to a branch. I will continue later.

[budziq]

Awesome!

I can't get the Ace editor to work now, so I can't document it.

I've stumbled on it just today when bumping mdbook version for rust-cookbook.
You need to enable it both in book.toml and annotate each snippet with rust,editable for it to work but I've decided against enabling for now as ACE goes wonky with # hidden lines.

[azerupi]

Oh I got it to work now!
I think it was a problem with enabling it while I used mdbook serve. Stopping the serve, running build and running serve again fixed it. :)

But it's late, I will continue another day 😉

[Michael-F-Bryan]

The configuration system has slightly changed (see #457) so that's another reason to put out 0.1 as the next release. I added a temporary compatibility thing which will still let you load the previous config file version, emitting a warning and migration instructions in the process.

I didn't know you could use the ACE editor to edit snippets. I'll check it out in the coming days and see if I can help document it.

[projektir]

Editable playpens/ACE have been documented (ish): #552.

[mattico]

The docs could still use some love, but I think this issue has been covered.