You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Marco Ieni 48a530218c
markdownlint: fix md004 (#175)
* markdownlint: fix md004

* use `-` for lists

Co-authored-by: simonsan <14062932+simonsan@users.noreply.github.com>
4 years ago
.github/workflows CI: Simplify lint job (#174) 4 years ago
anti_patterns Add markdownlint to CI (#164) 4 years ago
functional Reduce long lines (#176) 4 years ago
idioms Reduce long lines (#176) 4 years ago
patterns markdownlint: fix md004 (#175) 4 years ago
refactoring Apply markdownlint to project (#163) 4 years ago
.env Updating mdbook (#162) 4 years ago
.gitignore Adding mdbook configuration and deployment to gh-pages (#111) 4 years ago
.markdownlint.yaml markdownlint: fix md004 (#175) 4 years ago
CONTRIBUTING.md Updating Contrib (#181) 4 years ago
LICENSE Initial commit 9 years ago
README.md Updating Contrib (#181) 4 years ago
SUMMARY.md Adding design principles overview to additional resources (#179) 4 years ago
additional_resources.md Adding some additional resources (#159) 4 years ago
book.toml Adding mdbook configuration and deployment to gh-pages (#111) 4 years ago
design-principles.md Adding design principles overview to additional resources (#179) 4 years ago
intro.md Add participation to Introduction (#160) 4 years ago
template.md Apply markdownlint to project (#163) 4 years ago

README.md

Rust Design Patterns

An open source book about design patterns and idioms in the Rust programming language that you can read here.

Contributing

You are missing content in this repository that can be helpful for others and you are eager to explain it? Awesome! We are always happy about new contributions (e.g. elaboration or corrections on certain topics) to this project.

You can check the Umbrella issue for all the patterns, anti-patterns, and idioms that could be added.

We suggest reading our Contribution guide to get more information on how contributing to this repository works.

Building with mdbook

This book is built with mdbook. You can install it by running cargo install mdbook.

If you want to build it locally you can run one of these two commands in the root directory of the repository:

  • mdbook build

    Builds static html pages as output and place them in the /book directory by default.

  • mdbook serve

    Serves the book at http://localhost:3000 (port is changeable, take a look at the terminal output to be sure) and reloads the browser when a change occurs.

License

This content of this repository is licensed under MPL-2.0; see LICENSE.