WIP: Initial Askama Book

[cetra3]

As per twitter convo, here is a PR with an initial mdbook version of the documentation with a lot of the content copied from API inline docs.

You can view this with:

cd book && mdbook serve

I'm not sure if this is an approach you'd like to take, and so examples could possibly be put back into the API doc itself. I have just found when using other templates (such as tera), it's good to have a reference that is searchable.

[djc]

Thanks for your work! I guess this might make things easier to navigate. I'll take some time to play around with this.

[cetra3]

No worries! Let me know if I can help. I forgot to mention: I envisage this could be hosted with github pages or similar.

[djc]

Sorry for the slow cycle, but I really like the look of this. It seems like a big improvement compared to the linear documentation in the crate root. I suppose we should really prune the crate root docstring now as well as maybe make the README a bit more concise (in particular, link to the Debugging and Troubleshooting section in the book instead of having it inline). Would you mind doing that?

Also, I'd like to tweak the order of the book's chapters to list Debugging before Configuration.

[cetra3]

I've flipped the order for the the summary/table of contents.

In terms of referring to the book, did you have a URL In mind you want to host it on? Or should it simply just link to the markdown document in the /book

[djc]

I was going to set up GitHub pages after this merged.

[djc]

(Fixed the clippy issue on master.)

[djc]

So it should appear at https://djc.github.io/askama/ I guess (I don't have any experience with GitHub Pages yet, so will need to figure out how to make that happen from this).

[djc]

This has been merged.

[cetra3]

Ah all good. Apologies I didn't get to it sooner! I'm glad to see it's released though!