rust-unofficial / patterns

A catalogue of Rust design patterns, anti-patterns and idioms
https://rust-unofficial.github.io/patterns/
Mozilla Public License 2.0
8.11k stars 375 forks source link

Add github pages integration and mdbook for easy publishing and viewing #44

Closed Michael-F-Bryan closed 7 years ago

Michael-F-Bryan commented 8 years ago

I've got a personal project which does something pretty similar to this. It's essentially a git repository full of markdown pages.

What I did is use something called mdbook which will take all the markdown files and turn them into structured html. I then added a travis.yml which will rebuild the html every time I commit some work and then automatically push to the ghpages branch.

I was wondering if you wanted to do something similar to make it easier for people to read and navigate all the useful documents here. It shouldn't require much effort, you just put all the *.md source files in a src directory and write a short SUMMARY.md file to tell mdbook where everything goes.

here's my SUMMARY.md:

# Summary

- [Using this Document](./using-the-wiki.md)
- [JavaScript](./JavaScript/javascript.md)
- [Docker](./docker-images.md)
- [Python](./Python/index.md)
    - [SqlAlchemy](./Python/sqlalchemy.md)
- [Basic Server Setup](./basic-server-setup.md)
- [Rust](./Rust/index.md)
    - [Using Rust outside Rust](./Rust/rust_interop.md)
    - [Emails and Templates](./Rust/emails_and_templates.md)
- [Testing In C](./testing_in_c.md)
- [LaTeX Snippets](./latex.md)

And the generated documents are viewable here.

lambda-fairy commented 7 years ago

We should consider the original GitBook. It has built-in GitHub integration (so no fiddling with Travis), has a slick interface, and it's open source as well. Given that we're low on manpower, I'd prefer the solution that takes the least effort to set up and maintain -- GitBook is the best in that regard.

killercup commented 7 years ago

Dupe of #6?

lambda-fairy commented 7 years ago

Yep, I'd call it a dupe. Thanks for the pointer.