-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathDoc.html
More file actions
282 lines (245 loc) · 13 KB
/
Copy pathDoc.html
File metadata and controls
282 lines (245 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- css -->
<link rel="stylesheet" href="./assets/css/style.css">
<link rel="stylesheet" href="./assets/css/tools/doc.css">
<title>DevLab - Docomentation</title>
<!-- Meta Description: Accurately reflects the content of each page -->
<meta name="description"
content="Unlock the potential of DevLab, your comprehensive web development environment. Enjoy features like an integrated code editor, live preview, API documentation, and a suite of tools for seamless coding. Any developer can leverage our tools, and if the desired tool isn't available, contribute to add it! Join our community, contribute, and shape the ultimate web development toolkit.">
<link rel="canonical" href="https://devlab.nhussein.io" />
<!-- Favicon -->
<link rel="icon" type="image/png" sizes="32x32" href="./assets/logo/DevLab.png">
<link rel="icon" type="image/png" sizes="16x16" href="./assets/logo/DevLab.png">
<!-- CSS -->
<!-- js -->
<script src="./assets/js/core/dark-mode.js" defer></script>
<!-- Fonts -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link
href="https://fonts.googleapis.com/css2?family=Lato:wght@100;300;400&family=Source+Sans+3:wght@200;300;400;500;600;700&display=swap"
rel="stylesheet">
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:url" content="https://devlab.nhussein.io">
<meta property="og:title" content="DevLab - Web Development Environment">
<meta property="og:description"
content="Explore the features and functionalities of DevLab, a web development environment that enhances your coding experience.">
<meta property="og:image" content="./assets/logo/DevLab.png">
<!-- Twitter -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:url" content="https://devlab.nhussein.io">
<meta name="twitter:title" content="DevLab - Web Development Environment">
<meta name="twitter:description"
content="Explore the features and functionalities of DevLab, a web development environment that enhances your coding experience.">
<meta name="twitter:image" content="./assets/logo/DevLab.png">
<!-- Additional tags for SEO (if needed) -->
<!-- Meta Keywords (Optional): Skip or use sparingly -->
<meta name="keywords"
content="web development, coding, coding environment, DevLab, developer tools, code editor, live preview, code snippets, version control integration, API documentation viewer, linting, error checking, responsive design testing, performance analysis, debugging tools, HTML-to-JSX converter, validators, color picker, character encoding, CSS grid generator, flexbox generator, code minifiers, code beautifiers, performance testing, resume creator, portfolio conversion, linktree creation">
</head>
<body>
<!-- Navbar -->
<nav class="navbar">
<div class="logo">
<a href="index.html">
<img src="./assets/logo/DevLab.png" height="100px" alt="DevLab">
</a>
</div>
<div>
<ul class="nav-links">
<li><a class="nav-link" href="./index.html">DevLab</a></li>
<li><a href="./Doc.html" class="nav-link">Doc</a></li>
<!-- <li><a class="nav-link" href="index.html">Tools</a></li> -->
<li><a href="index.html#contribute" class="nav-link">Contribute</a></li>
</ul>
</div>
<!-- Dark and Light theme -->
<div class="dark-light-mode-theme">
<label class="switch">
<span class="sun"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<g fill="#ffd43b">
<circle r="5" cy="12" cx="12"></circle>
<path
d="m21 13h-1a1 1 0 0 1 0-2h1a1 1 0 0 1 0 2zm-17 0h-1a1 1 0 0 1 0-2h1a1 1 0 0 1 0 2zm13.66-5.66a1 1 0 0 1 -.66-.29 1 1 0 0 1 0-1.41l.71-.71a1 1 0 1 1 1.41 1.41l-.71.71a1 1 0 0 1 -.75.29zm-12.02 12.02a1 1 0 0 1 -.71-.29 1 1 0 0 1 0-1.41l.71-.66a1 1 0 0 1 1.41 1.41l-.71.71a1 1 0 0 1 -.7.24zm6.36-14.36a1 1 0 0 1 -1-1v-1a1 1 0 0 1 2 0v1a1 1 0 0 1 -1 1zm0 17a1 1 0 0 1 -1-1v-1a1 1 0 0 1 2 0v1a1 1 0 0 1 -1 1zm-5.66-14.66a1 1 0 0 1 -.7-.29l-.71-.71a1 1 0 0 1 1.41-1.41l.71.71a1 1 0 0 1 0 1.41 1 1 0 0 1 -.71.29zm12.02 12.02a1 1 0 0 1 -.7-.29l-.66-.71a1 1 0 0 1 1.36-1.36l.71.71a1 1 0 0 1 0 1.41 1 1 0 0 1 -.71.24z">
</path>
</g>
</svg></span>
<span class="moon"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512">
<path
d="m223.5 32c-123.5 0-223.5 100.3-223.5 224s100 224 223.5 224c60.6 0 115.5-24.2 155.8-63.4 5-4.9 6.3-12.5 3.1-18.7s-10.1-9.7-17-8.5c-9.8 1.7-19.8 2.6-30.1 2.6-96.9 0-175.5-78.8-175.5-176 0-65.8 36-123.1 89.3-153.3 6.1-3.5 9.2-10.5 7.7-17.3s-7.3-11.9-14.3-12.5c-6.3-.5-12.6-.8-19-.8z">
</path>
</svg></span>
<input id="dark-mode-toggle" type="checkbox" class="input">
<span class="slider"></span>
</label>
</div>
</nav>
<!-- Section Title -->
<div class="section-title">
<span class="line-span"></span>
<span class="tool-title"> Documentation</span>
<span class="line-span"></span>
</div>
<!-- Introduction Section -->
<section id="introduction" class="doc-section">
<h1>DevLab - Web Development Environment</h1>
<p>Version: 1.0.0</p>
<p>Author: <a href="https://nhussein.io" id="author">Nhussein</a></p>
<p>License: MIT</p>
<p>About: <br><br> DevLab is a web development environment that provides a suite of tools to enhance your coding
experience. This documentation will guide you through the features and functionalities of DevLab.</p>
</section>
<!-- Getting Started Section -->
<section id="getting-started" class="doc-section">
<h2>Getting Started</h2>
<!-- Installation Subsection -->
<section id="installation">
<h3>Installation</h3>
<h4>To get started with DevLab, follow these steps:</h4>
<ol>
<li>Clone the repository:</li>
<pre><code id="code-block">
git clone https://github.com/nhussein2026/DevLab.git
<button class="copy-btn" onclick="copyCode()">Copy</button>
</code></pre>
<li>Navigate to the project directory: <code>cd DevLab</code></li>
<li>Open <code id="code-text">index.html</code> in your preferred web browser.</li>
</ol>
<!-- Add more installation details as needed -->
</section>
<!-- Usage Subsection -->
<section id="usage">
<h3>Usage</h3>
<p>Once DevLab is open in your browser, you'll have access to a variety of tools and features.</p>
<!-- Add more usage details as needed -->
</section>
<section id="contribution">
<h3>Contribution</h3>
<p>After installing DevLab, you can contribute to the project by:</p>
<ol>
<li>Forking the repository on GitHub.</li>
<li>Creating a new branch for your feature or bug fix.</li>
<li>Implementing your changes.</li>
<li>Pushing your changes to your fork.</li>
<li>Opening a pull request on the main repository.</li>
</ol>
<p>For more details on how to contribute, please refer to the project's <a
href="CONTRIBUTING.md">CONTRIBUTING.md</a> file.</p>
</section>
</section>
<!-- seprator -->
<section class="seperator-section">
<h2>Features Docs</h2>
</section>
<!-- Code Editor Section -->
<section id="code-editor">
<h2>Code Editor</h2>
<p>DevLab includes a powerful code editor with syntax highlighting, line numbering, and code formatting.
to use the code editor:
</p>
<ol>
<li>Click on the "Code Editor" link in the tools section.</li>
<li>Start typing or paste your code into the editor.</li>
<li>Switch between programming languages using the language switch button.</li>
</ol>
<!-- Add more details about the code editor as needed -->
</section>
<!-- Live Preview Section -->
<section id="live-preview">
<h2>Live Preview</h2>
<p>The live preview feature allows you to see real-time output of your HTML, CSS, and JavaScript code.
To use live Preview:
</p>
<ol>
<li>Click on the "Live Preview" link in the tools sections.</li>
<li>Observe the changes in the preview area as you edit your code</li>
</ol>
<!-- Add more details about live preview as needed -->
</section>
<!-- Code Snippets Section -->
<section id="code-snippets" class="doc-section">
<h2>Code Snippets</h2>
<p>DevLab provides a collection of code snippets for common programming tasks. Users can also add and share
their own snippets.
To access the code snippets:</p>
<ol>
<li>Click on the "Code Snippets" link in the tools section.</li>
<li>Browse and search through the available snippets.</li>
<li>Use the "Contribute" button to add your own snippets.</li>
</ol>
</section>
<!-- API Viewer Section -->
<section id="api-viewer" class="doc-section">
<h2>API Endpoints Viewer</h2>
<p>Explore and test API endpoints directly within DevLab. To use the API Viewer:</p>
<ol>
<li>Enter the API endpoint URL in the input field.</li>
<li>Click "Fetch Data" to retrieve the response.</li>
<li>View the formatted JSON response and check headers/status.</li>
</ol>
</section>
<!-- HTML-to-JSX Section -->
<section id="html-to-jsx" class="doc-section">
<h2>HTML-to-JSX Converter</h2>
<p>Easily convert standard HTML into JSX for use in React components.</p>
<ol>
<li>Paste your HTML code into the input editor.</li>
<li>Click the "Convert to JSX" button.</li>
<li>Copy the resulting JSX code from the output editor.</li>
</ol>
</section>
<!-- Code Snippets Section -->
<section id="contributions">
<h2>Contributions to DevLab</h2>
<p>We welcome and appreciate contributions to enhance the DevLab developer tools platform. Here's how you can
contribute:</p>
<ol>
<li>Bug Reports:
<ul>
<li>Report any issues or bugs through our GitHub repository's "Issues" section.</li>
</ul>
</li>
<li>Feature Requests:
<ul>
<li>Suggest new features or improvements by creating an issue labeled "Feature Request."</li>
</ul>
</li>
<li>Code Contributions:
<ul>
<li>Fork the repository, create a new branch, and submit a pull request with your enhancements.</li>
<li>Ensure code follows our coding standards and test thoroughly.</li>
</ul>
</li>
<li>Documentation:
<ul>
<li>Help improve our documentation by submitting pull requests to the "docs" branch.</li>
</ul>
</li>
<li>Testing:
<ul>
<li>Test pre-releases and report any issues or feedback to assist in improving stability.</li>
</ul>
</li>
</ol>
<h3>Rules of contribution:</h3>
<ul>
<li>Follow the code of conduct outlined in the repository.</li>
<li>Be respectful and inclusive in all interactions.</li>
<li>Clearly describe and justify your changes in pull requests.</li>
<li>Ensure your contributions align with the project's goals and roadmap.</li>
</ul>
<!-- Link to Contribution Guidelines -->
<p>Ready to contribute? Check out our <a id="author" href="CONTRIBUTING.md" target="_blank"
rel="noopener">Contribution Guidelines</a> for
detailed instructions.</p>
</section>
<!-- JavaScript code -->
<script src="./assets/js/core/copy.js"></script>
<script src="./assets/js/core/dark-mode.js"></script>
</body>
</html>