Git Product home page Git Product logo

neoalgo-docs's Introduction

NeoAlgo-Docs

Bringing an all Open-Source Platform to study Data Structures and Algorithms ⚡

🔧 Installation

You will need to have NodeJS and Yarn installed, if you haven't done that yet - get started here and here. Then, follow the steps below ⬇️

$ git clone [email protected]:TesseractCoding/NeoAlgo-Docs.git
$ cd NeoAlgo-Docs
$ yarn
$ yarn start

Finally, navigate to http://localhost:3000 and you should see our app is now up and running ⚡

Powered by Vercel

neoalgo-docs's People

Contributors

aaadddiii avatar amit366 avatar ankitaggarwal23 avatar anshmishra010 avatar ashukv avatar atarax665 avatar bhav09 avatar deepali-suk avatar deepika-suk avatar deeptea22 avatar gayatri517 avatar harikrishnan6336 avatar harshcasper avatar iamrajiv avatar madihamallick avatar nagasrihith608 avatar neerajap2001 avatar nidh-ish avatar raiyanmahin avatar ravireddy07 avatar rubyruins avatar ruchigithu avatar saatviknagpal avatar satcasm avatar say-droid427 avatar shivammahajancse avatar siddharth25pandey avatar tanvi355 avatar tk315 avatar vybhav72954 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

neoalgo-docs's Issues

Content: Jump Search

Description

Add the article for Jump Search. The basic layout for the article should be:

  • What is Jump Search?
  • Explanation for Jump Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Binary Search

Description

Add the article for Binary Search. The basic layout for the article should be:

  • What is Binary Search?
  • Explanation for Binary Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Develop a Style handbook

Description

As a first-time contributor, many people aren't aware of the Markdown Style that needs to be followed while working on a Documentation Site. Create a Style Handbook titled STYLE-GUIDELINES.md which would be then added to the site.

The Style Handbook would extract information from here and would make it specific to our Docs.

Content: What are Sorting Algorithms?

Description

Add the article for What are Sorting Algorithms. The basic layout for the article should be:

  • Introduction to Sorting
  • What are Sorting Algorithms?
  • Popular Sorting Algorithms
  • Comparison of these algorithms

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Documentation for Krishnamurthy Number

I would like to add an article for Krishnamurthy Number. The basic layout for the article will be:

What is Krishnamurthy Number?
Explanation for Krishnamurthy Number
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Have you read the Contributing Guidelines on Pull Requests?

YES

Content: Caesar Cipher

Description

Add the article for Caesar Cipher. The basic layout for the article should be:

  • What is Caesar Cipher?
  • Explanation for Caesar Cipher
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Binary Tree

Description

Add the article for Binary Tree. The basic layout for the article should be:

  • What are Binary Trees?
  • Explanation for Binary Tree
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Anagram Numbers

Description

Add the article for Anagram Numbers. The basic layout for the article should be:

  • Intro to Anagram Numbers problem
  • Explanation for the problem and solution
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Insertion Sort

📚 Documentation

Add the article for Bubble Sort. The basic layout for the article:

What is Insertion Sort?
An explanation for Insertion Sort
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article will be between 500-700 words in length.

Have you read the Contributing Guidelines on Pull Requests?

Yes

Article for Counting Sort

🚀 Feature

I would like to add an article for Counting Sort. The basic layout for the article will be:

What is Counting Sort?
Explanation for Counting Sort
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Have you read the Contributing Guidelines on Pull Requests?

(Yes)

Add Twitter Card and Tesseract Coding logo to the Open Graph Image metadata of https://neoalgo.tesseractcoding.com

🚀 Feature

When we share https://neoalgo.tesseractcoding.com over social media like Twitter, it is good that the card they generate for the link has useful information.

Screenshot 2021-04-08 at 4 21 59 AM

Currently, Twitter does not render and get any image to use for https://neoalgo.tesseractcoding.com.

Possible Implementation:

Add an og:image metadata to the website and use the Tesseract Coding logo. Use png instead of SVG here.

Context:

Use https://cards-dev.twitter.com/validator to validate results.

Content : Next Permutation

Description
Add the article for Next Permutation. The basic layout for the article should be:

What is Next Permutation?
The explanation for Next Permutation
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

I will be using my code itself ( merged in neoalgo repo).

Add a GH Action to test the Application Build

Description

Add a Github Action that checks out the repo on every commit and pull requests and installs all the dependencies and checks the build. This would ensure that people are not making lazy contributions and follow the contribution guidelines strictly.

Content: Bipartite Check

Add the article for Bipartite Check. The basic layout for the article should be:

  • What is Bipartite Check?
  • Explanation for Bipartite Check
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Article for Heap Sort

I would like to add an article for Heap Sort. The basic layout for the article will be:

What is Heap Sort?
Explanation for Heap Sort
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Bubble Sort

Description

Add the article for Bubble Sort. The basic layout for the article should be:

  • What is Bubble Sort?
  • Explanation for Bubble Sort
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Fibonacci Search

Description

Add the article for Fibonacci Search. The basic layout for the article should be:

  • What is Fibonacci Search?
  • Explanation for Fibonacci Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Develop a Doc Guideline

Description

We need to have a Doc Guideline so that the new contributors know on how they can format their articles for publishing over the website. Right now we have two types of content:

  • Docs
  • Blogs

Blogs are reserved for the core maintainers unless stated otherwise. The Docs would consist of articles over various Data Structures and Algorithms that are available on the upstream (NeoAlgo) repository. Your Doc Guideline should contain information and basic sections on how someone can write an article for the website.

You can get inspired from these:

Content: What are Data Structures

Description

Add the article for What are Data Structures. The basic layout for the article should be:

  • Introduction to Data Structures
  • Types of Data Structures
  • Major Operations in Data Structures
  • Advantages of Data Structures

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Jarvis Algorithm

Description

Add the article for Jarvis Algorithm. The basic layout for the article should be:

  • What is Jarvis Algorithm?
  • Explanation for Jarvis Algorithm
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: N-Queens

Description

Add the article for N Queens. The basic layout for the article should be:

  • What is the N Queens Problem?
  • Explanation for N Queen
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Brian Kernighan Algorithm

Description

Add the article for Brian Kernighan Algorithm. The basic layout for the article should be:

  • What is Brian Kernighan Algorithm?
  • Explanation for Brian Kernighan Algorithm
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Setup Docusaurus

This Issue would require:

  • Setting up Docusaurus
  • Deploying the site over Vercel
  • Adding some basic information about NeoAlgo

Article for Selection Sort

I would like to add an article for SelectionSort. The basic layout for the article will be:

What is Selection Sort?
Explanation for Selection Sort
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Armstrong Number

Description

Add the article for Armstrong Number. The basic layout for the article should be:

  • What is Armstrong Number?
  • Explanation for Armstrong Number
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Interpolation Search

Description

Add the article for Interpolation Search. The basic layout for the article should be:

  • What is Interpolation Search?
  • Explanation for Interpolation Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Linear Search

Description

Add the article for Linear Search. The basic layout for the article should be:

  • What is Linear Search?
  • Explanation for Linear Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: Breadth First Search

Description

Add the article for Breadth-First Search. The basic layout for the article should be:

  • What is Breadth-First Search?
  • Explanation for Breadth-First Search
  • Algorithmic Steps
  • Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
  • Sample I/O
  • Time & Space Complexity

This article should be between 700-1000 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Content: What are Search Algorithms?

Description

Add the article for What are Search Algorithms. The basic layout for the article should be:

  • Introduction to Searching
  • What are Searching Algorithms?
  • Popular Searching Algorithms
  • Comparison of these algorithms

This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Happy Number documentation

📚 Documentation

(A clear and concise description of what the issue is.)
Add the article for Armstrong Number. The basic layout for the article should be:

What is Happy Number?
The explanation for Happy Number
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Have you read the Contributing Guidelines on Pull Requests?

(Write your answer here.)
yes

Magic number documentation

📚 Documentation

(A clear and concise description of what the issue is.)
Add the article for Armstrong Number. The basic layout for the article should be:

What is Magic Number?
Explanation for Magic Number
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Have you read the Contributing Guidelines on Pull Requests?

(Write your answer here.)
yes

Article for QuickSort

🚀 Feature

I would like to add an article for QuickSort. The basic layout for the article will be:

What is Quick Sort?
Explanation for Quick Sort
Algorithmic Steps
Code (Use C++/Java and Python; At least two languages should be present and pick up code from NeoAlgo with apt credits to author)
Sample I/O
Time & Space Complexity
This article should be between 500-700 words in length. You should use traditional Markdown to prepare the content and the use of external images is prohibited. You can however create your own images. Run a proper Grammarly Lint check before submitting the PR.

Have you read the Contributing Guidelines on Pull Requests?

(Yes)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.