Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1015 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1015 Bytes

Contributing

First of all, thank you for reading here to contribute! I really appriciate that.

Share experience

If you want to share your interview experience, create a directory with company name (if not exist) and put your md file in it. Then for compile, you need to add your md file path to SUMMARY.md. Just like this:

src/snapp
├── snapp_cab_1.md
└── snapp_cab_2.md

You can add your name (if you like) after the company name like: snapp_moein.md and that's good to write it in the file otherwise, write unknown.

Install

You need to install mdbook. Just install binaries if you are not familiar with rust and cargo.
Watch this link for releases.
For mermaid charts, install this.

Build

For building after your changes in the root dir of project:

mdbook build .

Or you can build and serve to watch your changes:

mdbook serve --open