docs?

[amueller]

This looks amazing. Could you maybe write some docs? Maybe I overlooked them. What's the syntax for specifying links? Currently nbconvert doesn't even have links inside a single notebook, right?

[willingc]

@takluyver Cool! Happy to review/pitch in with docs.

[ketch]

I made an attempt to get this started with #8.

[takluyver]

The lack of docs here is kind of semi-deliberate - this is still a pretty rough and ready tool that I threw together for a need here at Southampton, and I don't want to raise expectations too much for people who come across it. There are unresolved questions about how to work with a collection of notebooks, and it's fairly brittle in the versions of nbconvert and pandoc it needs.

However, I'm happy that other people are looking into using it, and I'm not going to refuse docs if they appear.

[takluyver]

Currently nbconvert doesn't even have links inside a single notebook, right?

It didn't when I wrote bookbook, but we've since copied over part of bookbook's logic for converting the Markdown links within-notebook to Latex references.