Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit e0fc676

Browse files
RanitManikRanitManik
authored
Update README.md
1 parent da4883a commit e0fc676

File tree

1 file changed

+158
-1
lines changed

1 file changed

+158
-1
lines changed

‎README.md

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,158 @@
1-
# JavaScript-Docs
1+
<a name="readme-top"></a>
2+
<br />
3+
<div align="center">
4+
<a href="https://ranitmanik.github.io/JavaScript-SuperSimpleDev-Docs">
5+
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/6/6a/JavaScript-logo.png/768px-JavaScript-logo.png" alt="Logo" height="100px">
6+
</a>
7+
<h1> JavaScript Super Simple Dev Docs
8+
</h1>
9+
<a href="https://ranitmanik.github.io/JavaScript-SuperSimpeDev-Docs">Visit the Website »</a>
10+
<br >
11+
<br>
12+
<a href="https://ranitmanik.github.io/JavaScript-SuperSimpeDev-Docs/">View Demo</a>
13+
·
14+
<a href=".github/ISSUE_TEMPLATE/bug_report.md">Report Bug</a>
15+
·
16+
<a href=".github/ISSUE_TEMPLATE/feature_request.md">Request Feature</a>
17+
</div>
18+
<br>
19+
20+
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.
21+
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
22+
using [JetBrains Writerside IDE](https://www.jetbrains.com/writerside/). To contribute to this project, it is
23+
recommended to download and utilize JetBrains [Writerside IDE](https://www.jetbrains.com/writerside/) for an optimal
24+
development experience.
25+
26+
## Table of Contents
27+
28+
- [Features](#features)
29+
- [Who Is This For?](#who-is-this-for)
30+
- [Technologies Used](#technologies-used)
31+
- [Contribution](#how-to-contribute)
32+
- [Support and Contribution](#support-and-contribution)
33+
- [License](#license)
34+
- [Contact](#contact)
35+
- [Acknowledgment](#acknowledgment)
36+
37+
## Features
38+
39+
- **Structured Learning:** Follow a carefully designed structure, progressing from basic concepts to advanced
40+
techniques.
41+
42+
- **Hands-On Examples:** Learn by doing with practical examples and exercises to reinforce your understanding.
43+
44+
- **Visual Learning:** Enhance your comprehension with visual aids, diagrams, and code snippets.
45+
46+
## Who Is This For?
47+
48+
- **Beginners:** Tailored for individuals new to programming or JavaScript development.
49+
50+
- **Enthusiasts:** Ideal for those with a keen interest in understanding the foundations of the JavaScript language.
51+
52+
53+
## Technologies Used
54+
55+
| Tool | Description |
56+
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
57+
| **WriterSide IDE** | Leveraged JetBrains WriterSide IDE for an optimal development experience and streamlined coding. |
58+
| **Git** | Version control system utilized for tracking changes and collaborating with contributors. |
59+
| **GitHub** | Hosting platform employed for version control, collaboration, and project management. |
60+
| **GitHub Actions** | Automated workflows set up for continuous integration and continuous deployment, ensuring efficient development. |
61+
| **CI/CD** | Implementation of CI/CD practices to automate testing and deployment, enhancing the overall development workflow. |
62+
| **XML** | Used for structured data representation, enhancing the organization of certain aspects of the project. |
63+
| **YML** | Configuration language employed for defining GitHub Actions workflows and other settings. |
64+
| **Markdown** | Lightweight markup language used for easy-to-read and easy-to-write documentation. |
65+
| **MIT License** | Open-source license applied to the project, providing users with the freedom to use, modify, and distribute the software. |
66+
| **algoila Search** | Incorporation of algoila Search for efficient and effective search functionality within the documentation. |
67+
68+
## How to Contribute
69+
70+
1. **Fork the Repository:** Fork the JavaScript Super Simple Dev Docs repository to your GitHub account.
71+
```bash
72+
git clone https://github.com/RanitManik/JavaScript-SuperSimpleDev-Docs.git
73+
```
74+
2. **Create a Branch:** Create a new branch for your contribution using a descriptive branch name.
75+
76+
```bash
77+
git checkout -b feature/your-feature-name
78+
```
79+
80+
3. **Make Changes:** Implement your changes or additions to the documentation.
81+
82+
4. **Commit Your Changes:** Commit your changes with a clear and concise commit message.
83+
84+
```bash
85+
git commit -am 'Add some feature'
86+
```
87+
88+
5. **Push to Your Fork:** Push your changes to your forked repository.
89+
90+
```bash
91+
git push origin feature/your-feature-name
92+
```
93+
94+
6. **Submit a Pull Request:** Open a pull request to the main repository, clearly describing your changes.
95+
96+
## Support and Contribution
97+
98+
- For support, questions, or suggestions, please refer to the [Support Guidelines](support.md).
99+
100+
- To contribute to the project, follow the [Contribution Guidelines](contribution.md).
101+
102+
## License
103+
104+
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE.md](LICENSE) file for details.
105+
106+
## Contact
107+
108+
<table>
109+
<tr>
110+
<th></th>
111+
<th>Social Media</th>
112+
<th>Username</th>
113+
<th>Link</th>
114+
</tr>
115+
<tr>
116+
<td><img src="https://cdn4.iconfinder.com/data/icons/social-media-logos-6/512/112-gmail_email_mail-512.png" width="20" /></td>
117+
<td>Email</td>
118+
<td><code>[email protected]</code></td>
119+
<td><a href="mailto:[email protected]" target="_blank">Email</a></td>
120+
</tr>
121+
<tr>
122+
<td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/c/ca/LinkedIn_logo_initials.png/480px-LinkedIn_logo_initials.png" width="20" /></td>
123+
<td>LinkedIn</td>
124+
<td><code>Ranit Manik</code></td>
125+
<td><a href="https://www.linkedin.com/in/ranit-manik/" target="_blank">LinkedIn</a></td>
126+
</tr>
127+
<tr>
128+
<td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Instagram_icon.png/600px-Instagram_icon.png" width="20" /></td>
129+
<td>Instagram</td>
130+
<td><code>ranit_manik_</code></td>
131+
<td><a href="https://www.instagram.com/ranit_manik_/" target="_blank">Instagram</a></td>
132+
</tr>
133+
<tr>
134+
<td><img src="https://upload.wikimedia.org/wikipedia/commons/6/6c/Facebook_Logo_2023.png" width="20" /></td>
135+
<td>Facebook</td>
136+
<td><code>RanitKumarManik</code></td>
137+
<td><a href="https://www.facebook.com/RanitKumarManik/" target="_blank">Facebook</a></td>
138+
</tr>
139+
<tr>
140+
<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>
141+
<td>Twitter</td>
142+
<td><code>RANIT_MANIK</code></td>
143+
<td><a href="https://twitter.com/RANIT_MANIK" target="_blank">Twitter</a></td>
144+
</tr>
145+
</table>
146+
147+
## Acknowledgment
148+
149+
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.
150+
151+
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.
152+
153+
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.
154+
155+
Thank you for your valuable contributions.
156+
157+
Best regards,
158+
Ranit Manik

0 commit comments

Comments
 (0)