search

rust-unofficial / patterns

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

Hosting mdbook with gh-pages #111

Closed simonsan closed 3 years ago

simonsan commented 3 years ago

This adds a book.toml configuration file and some (still empty) Readme.md files to the categories.

Output can be followed here

Filling the descriptions of the categories I think would make sense to make in another PR, due to possible discussions about the content. For now I think just adding this should be fine. Thoughts/feedback?

Regarding the domain: Renaming this repository to 'rust-patterns' on the discussion board: https://github.com/rust-unofficial/patterns/discussions/113

supersedes #53 fixes #6

MarcoIeni commented 3 years ago

Adding instructions on how to build the book in the readme or in contribution guidelines might be nice. something like

cargo install mdbook
mdbook serve
simonsan commented 3 years ago

Adding instructions on how to build the book in the readme or in contribution guidelines might be nice. something like

cargo install mdbook
mdbook serve

Added ;-)

MarcoIeni commented 3 years ago

Looks good to me. Are you planning to add categories?