Skip to content

Commit 36ce013

Browse files
prathmeshyelneprathmeshyelne
committed
add .github
1 parent e6548d6 commit 36ce013

File tree

5 files changed

+124
-48
lines changed

5 files changed

+124
-48
lines changed

‎.github/FUNDING.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# These are supported funding model platforms
2+
3+
github: [ prathmeshyelne ]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Bug report
2+
description: Report an issue or bug with this Advanced HTML Snippets extension
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: checkboxes
10+
id: non_api
11+
attributes:
12+
label: Confirm this is a Advanced HTML Snippets extension issue and not an underlying issue
13+
description: Issues with the underlying should be reported on our [Developer Community](https://support.codegyan.in)
14+
options:
15+
- label: This is an issue with the Advanced HTML Snippets extension
16+
required: true
17+
- type: textarea
18+
id: what-happened
19+
attributes:
20+
label: Describe the bug
21+
description: A clear and concise description of what the bug is, and any additional context.
22+
placeholder: Tell us what you see!
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: code-snippets
27+
attributes:
28+
label: Code snippets
29+
description: If applicable, add code snippets to help explain your problem.
30+
render: JavaScript
31+
validations:
32+
required: false
33+
- type: input
34+
id: os
35+
attributes:
36+
label: OS
37+
placeholder: macOS
38+
validations:
39+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature request
2+
description: Suggest an idea for this Advanced HTML Snippets extension
3+
labels: ['feature-request']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this feature request!
9+
- type: checkboxes
10+
id: non_api
11+
attributes:
12+
label: Confirm this is a feature request for the extension.
13+
description: Feature requests for this Advanced HTML Snippets should be reported on our [Developer Community](https://support.codegyan.in)
14+
options:
15+
- label: This is a feature request for the Advanced HTML Snippets extension
16+
required: true
17+
- type: textarea
18+
id: feature
19+
attributes:
20+
label: Describe the feature or improvement you're requesting
21+
description: A clear and concise description of what you want to happen.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: Additional context
28+
description: Add any other context about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!-- Thank you for contributing to this project! -->
2+
<!-- The code in this repository is all auto-generated, and is not meant to be edited manually. -->
3+
<!-- We recommend opening an Issue instead, but you are still welcome to open a PR to share for -->
4+
<!-- an improvement if you wish, just note that we are unlikely to merge it as-is. -->
5+
6+
- [ ] I understand that this repository is auto-generated and my pull request may not be merged
7+
8+
## Changes being requested
9+
10+
## Additional context & links

‎README.md‎

Lines changed: 33 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,50 @@
1-
# html-snippets README
1+
# Advanced HTML Snippets for Visual Studio Code
22

3-
This is the README for your extension "html-snippets". After writing up a brief description, we recommend including the following sections.
3+
A collection of handy HTML snippets designed to speed up your web development workflow. This extension includes basic HTML boilerplates, common HTML tags, and other useful snippets for HTML coding.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
- **Basic HTML5 Boilerplate**: Quickly insert a basic HTML5 structure with a single snippet.
8+
- **HTML Link Tag**: Add a link tag for external stylesheets.
9+
- **Other HTML Tags**: Includes snippets for tags like `div`, `a`, `img`, `button`, and more.
810

9-
For example if there is an image subfolder under your extension project workspace:
11+
## Installation
1012

11-
\!\[feature X\]\(images/feature-x.png\)
13+
### Via VS Code Marketplace
1214

13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
15+
1. Open **Visual Studio Code**.
16+
2. Navigate to the **Extensions** view by clicking the Extensions icon in the Activity Bar on the side of the window or pressing `Ctrl+Shift+X`.
17+
3. Search for `Advanced HTML Snippets` in the Extensions Marketplace.
18+
4. Click **Install**.
1419

15-
## Requirements
20+
### Manually (for development or testing)
1621

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
22+
1. Clone this repository:
23+
```bash
24+
git clone https://github.com/your-repo/html-snippets.git
25+
```
1826

19-
## Extension Settings
27+
2. Open the project folder in Visual Studio Code.
28+
3. Press F5 to run and test the extension in a new VS Code window.
2029

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
30+
## Usage
31+
Once installed, you can use the following snippets by typing their prefix and hitting Tab to expand them:
2232

23-
For example:
33+
### Available Snippets
2434

25-
This extension contributes the following settings:
35+
- !html5: Inserts a basic HTML5 boilerplate structure.
36+
- !!html5: Inserts a advanced HTML5 boilerplate structure.
37+
- link: Adds an HTML <link> tag for including an external stylesheet.
38+
- div: Inserts a <div> tag.
39+
- a: Inserts an <a> tag for links.
40+
- img: Adds an <img> tag for images.
41+
- button: Inserts a <button> tag.
2642

27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
43+
### Example:
44+
1. In an HTML file, type !html5 and press Tab.
45+
2. The following code will be inserted:
2946

30-
## Known Issues
47+
<img src="https://github.com/Codegyan-LLC/advanced-html-snippets
48+
/blob/main/images/code.png" width="600" alt="basic html snippets">
3149

32-
Calling out known issues can help limit users opening duplicate issues against your extension.
3350

34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Working with Markdown
53-
54-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
57-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
58-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
59-
60-
## For more information
61-
62-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
64-
65-
**Enjoy!**

0 commit comments

Comments
 (0)