Skip to content
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

WIP: Initial Askama Book #332

Closed
wants to merge 2 commits into from
Closed

WIP: Initial Askama Book #332

wants to merge 2 commits into from

Conversation

cetra3
Copy link
Contributor

@cetra3 cetra3 commented May 28, 2020

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
Copy link
Owner

djc commented May 28, 2020

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

@cetra3
Copy link
Contributor Author

cetra3 commented May 28, 2020

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
Copy link
Owner

djc commented Jun 23, 2020

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
Copy link
Contributor Author

cetra3 commented Jun 24, 2020

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
Copy link
Owner

djc commented Jun 24, 2020

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

@djc
Copy link
Owner

djc commented Jun 24, 2020

(Fixed the clippy issue on master.)

@djc
Copy link
Owner

djc commented Jun 24, 2020

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 djc mentioned this pull request Jun 25, 2020
@djc
Copy link
Owner

djc commented Jun 29, 2020

This has been merged.

@djc djc closed this Jun 29, 2020
@cetra3
Copy link
Contributor Author

cetra3 commented Jun 30, 2020

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

cipriancraciun pushed a commit to cipriancraciun/askama that referenced this pull request Jun 30, 2020
couchand pushed a commit to couchand/askama that referenced this pull request Jul 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants