This repository has been archived by the owner on Jun 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
da4883a
commit e0fc676
Showing
1 changed file
with
158 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,158 @@ | ||
| # JavaScript-Docs | ||
| <a name="readme-top"></a> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://ranitmanik.github.io/JavaScript-SuperSimpleDev-Docs"> | ||
| <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/6a/JavaScript-logo.png/768px-JavaScript-logo.png" alt="Logo" height="100px"> | ||
| </a> | ||
| <h1> JavaScript Super Simple Dev Docs | ||
| </h1> | ||
| <a href="https://ranitmanik.github.io/JavaScript-SuperSimpeDev-Docs">Visit the Website »</a> | ||
| <br > | ||
| <br> | ||
| <a href="https://ranitmanik.github.io/JavaScript-SuperSimpeDev-Docs/">View Demo</a> | ||
| · | ||
| <a href=".github/ISSUE_TEMPLATE/bug_report.md">Report Bug</a> | ||
| · | ||
| <a href=".github/ISSUE_TEMPLATE/feature_request.md">Request Feature</a> | ||
| </div> | ||
| <br> | ||
|
|
||
| Welcome to JavaScript Super Simple Dev Docs! This project aims to provide an easy-to-follow documentation for beginners and enthusiasts diving into the world of JavaScript programming. | ||
| This documentation is authored by Ranit Manik, a dedicated programmer proficient in JavaScript, Python, and Java. The primary objective of this project is to offer a well-organized and beginner-friendly guide for mastering the fundamentals of JavaScript programming. The development of this project is facilitated | ||
| using [JetBrains Writerside IDE](https://www.jetbrains.com/writerside/). To contribute to this project, it is | ||
| recommended to download and utilize JetBrains [Writerside IDE](https://www.jetbrains.com/writerside/) for an optimal | ||
| development experience. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Features](#features) | ||
| - [Who Is This For?](#who-is-this-for) | ||
| - [Technologies Used](#technologies-used) | ||
| - [Contribution](#how-to-contribute) | ||
| - [Support and Contribution](#support-and-contribution) | ||
| - [License](#license) | ||
| - [Contact](#contact) | ||
| - [Acknowledgment](#acknowledgment) | ||
|
|
||
| ## Features | ||
|
|
||
| - **Structured Learning:** Follow a carefully designed structure, progressing from basic concepts to advanced | ||
| techniques. | ||
|
|
||
| - **Hands-On Examples:** Learn by doing with practical examples and exercises to reinforce your understanding. | ||
|
|
||
| - **Visual Learning:** Enhance your comprehension with visual aids, diagrams, and code snippets. | ||
|
|
||
| ## Who Is This For? | ||
|
|
||
| - **Beginners:** Tailored for individuals new to programming or JavaScript development. | ||
|
|
||
| - **Enthusiasts:** Ideal for those with a keen interest in understanding the foundations of the JavaScript language. | ||
|
|
||
|
|
||
| ## Technologies Used | ||
|
|
||
| | Tool | Description | | ||
| | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | ||
| | **WriterSide IDE** | Leveraged JetBrains WriterSide IDE for an optimal development experience and streamlined coding. | | ||
| | **Git** | Version control system utilized for tracking changes and collaborating with contributors. | | ||
| | **GitHub** | Hosting platform employed for version control, collaboration, and project management. | | ||
| | **GitHub Actions** | Automated workflows set up for continuous integration and continuous deployment, ensuring efficient development. | | ||
| | **CI/CD** | Implementation of CI/CD practices to automate testing and deployment, enhancing the overall development workflow. | | ||
| | **XML** | Used for structured data representation, enhancing the organization of certain aspects of the project. | | ||
| | **YML** | Configuration language employed for defining GitHub Actions workflows and other settings. | | ||
| | **Markdown** | Lightweight markup language used for easy-to-read and easy-to-write documentation. | | ||
| | **MIT License** | Open-source license applied to the project, providing users with the freedom to use, modify, and distribute the software. | | ||
| | **algoila Search** | Incorporation of algoila Search for efficient and effective search functionality within the documentation. | | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| 1. **Fork the Repository:** Fork the JavaScript Super Simple Dev Docs repository to your GitHub account. | ||
| ```bash | ||
| git clone https://github.com/RanitManik/JavaScript-SuperSimpleDev-Docs.git | ||
| ``` | ||
| 2. **Create a Branch:** Create a new branch for your contribution using a descriptive branch name. | ||
|
|
||
| ```bash | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
|
|
||
| 3. **Make Changes:** Implement your changes or additions to the documentation. | ||
|
|
||
| 4. **Commit Your Changes:** Commit your changes with a clear and concise commit message. | ||
|
|
||
| ```bash | ||
| git commit -am 'Add some feature' | ||
| ``` | ||
|
|
||
| 5. **Push to Your Fork:** Push your changes to your forked repository. | ||
|
|
||
| ```bash | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
|
|
||
| 6. **Submit a Pull Request:** Open a pull request to the main repository, clearly describing your changes. | ||
|
|
||
| ## Support and Contribution | ||
|
|
||
| - For support, questions, or suggestions, please refer to the [Support Guidelines](support.md). | ||
|
|
||
| - To contribute to the project, follow the [Contribution Guidelines](contribution.md). | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](LICENSE) - see the [LICENSE.md](LICENSE) file for details. | ||
|
|
||
| ## Contact | ||
|
|
||
| <table> | ||
| <tr> | ||
| <th></th> | ||
| <th>Social Media</th> | ||
| <th>Username</th> | ||
| <th>Link</th> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://cdn4.iconfinder.com/data/icons/social-media-logos-6/512/112-gmail_email_mail-512.png" width="20" /></td> | ||
| <td>Email</td> | ||
| <td><code>ranitmanik.dev@gmail.com</code></td> | ||
| <td><a href="mailto:ranitmanik.dev@gmail.com" target="_blank">Email</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/c/ca/LinkedIn_logo_initials.png/480px-LinkedIn_logo_initials.png" width="20" /></td> | ||
| <td>LinkedIn</td> | ||
| <td><code>Ranit Manik</code></td> | ||
| <td><a href="https://www.linkedin.com/in/ranit-manik/" target="_blank">LinkedIn</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Instagram_icon.png/600px-Instagram_icon.png" width="20" /></td> | ||
| <td>Instagram</td> | ||
| <td><code>ranit_manik_</code></td> | ||
| <td><a href="https://www.instagram.com/ranit_manik_/" target="_blank">Instagram</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://upload.wikimedia.org/wikipedia/commons/6/6c/Facebook_Logo_2023.png" width="20" /></td> | ||
| <td>Facebook</td> | ||
| <td><code>RanitKumarManik</code></td> | ||
| <td><a href="https://www.facebook.com/RanitKumarManik/" target="_blank">Facebook</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/6f/Logo_of_Twitter.svg/512px-Logo_of_Twitter.svg.png" width="20" /></td> | ||
| <td>Twitter</td> | ||
| <td><code>RANIT_MANIK</code></td> | ||
| <td><a href="https://twitter.com/RANIT_MANIK" target="_blank">Twitter</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Acknowledgment | ||
|
|
||
| I want to express my sincere appreciation to all contributors who have played a vital role in the development of JavaScript Super Simple Dev Docs. Your dedication and collaborative efforts have significantly enriched this documentation, making it a valuable asset for individuals venturing into JavaScript programming. | ||
|
|
||
| The structured learning approach, practical examples, and visual aids have been enhanced through your valuable contributions, creating a more effective resource for learners. Your commitment to forking, creating branches, and submitting pull requests has been pivotal in shaping the project. | ||
|
|
||
| I genuinely appreciate the time and expertise each contributor has invested. Your efforts have not gone unnoticed, and I am grateful for the collective impact we have made on JavaScript Super Simple Dev Docs. | ||
|
|
||
| Thank you for your valuable contributions. | ||
|
|
||
| Best regards, | ||
| Ranit Manik |