codeiiest-dev / Algorithms

Collection of algorithms to read, learn and contribute to.
https://codeiiest-dev.github.io/Algorithms/
MIT License
23 stars 14 forks source link
algorithms mdbook

Algorithms

[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=for-the-badge)](#contributors)

About the Project

This repository contains some of the most intriguing and awesome algorithms of daily life implemented in languages primarily in C/C++/Java/Python.

Project Details

The entire project is divided into 4 parts

General

The summary file is used by mdBook to know what chapters to include, in what order they should appear, what their hierarchy is and where the source files are. Without this file, there is no book.

Even though SUMMARY.md is a markdown file, the formatting is very strict to allow for easy parsing. Let's look at how to edit SUMMARY.md.

# Summary

- [Introduction](./introduction.md)

Now you want to add a topic Topic 1. And it will have some subtopics Sub-Topic1 and Sub-Topic2.

# Summary

- [Introduction](./introduction.md)
- [Topic 1](./relative/path/to/Topic-1.md)
  - [Sub Topic 1](./relative/path/to/sub-topic1.md)
  - [Sub Topic 2](./relative/path/to/sub-topic2.md)

It is advised to maintain the same folder structure for the markdown files as well. So the Topic-1 folders will have a structure like:

src
├── introduction.md
├── SUMMARY.md
└── Topic-1
    ├── Sub-Topic-1
    │   ├── sub-topic-1.md
    │   └── sub-topic-2.md
    └── Topic-1.md

Also you need to follow proper markdown syntax for your contribution to be considered. You can refer to this guide.

Contribution Guidelines

Please refer here for our contributing guidelines.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Arnab Sen

🚧

Anik Das

🚧

Rahul Halder

🚧

Dwaipayan Ray

🚧

souvikmahato-sm

📖

Prerna Gupta

📖

Manish Kundu

📖

Anirban Sikder

📖

Sanjana Chakravarty

📖

Ahel Das Chatterjee

📖

Yukti-1

📖

Siddhant Khare

📖

Abhiroop25902

📖

This project follows the all-contributors specification. Contributions of any kind welcome!