Skip to content

Commit ae62c11

Browse files
author
Jerry Lopez
committed
Remove boilerplate and start docs
1 parent 383122a commit ae62c11

File tree

3 files changed

+20
-92
lines changed

3 files changed

+20
-92
lines changed

CHANGELOG.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 20 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,20 @@
1-
# magento2-snippets README
2-
3-
This is the README for your extension "magento2-snippets". After writing up a brief description, we recommend including the following sections.
4-
5-
## Features
6-
7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8-
9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
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.
14-
15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: enable/disable this extension
28-
* `myExtension.thing`: set to `blah` to do something
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
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-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux)
57-
* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux)
58-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) 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!**
1+
# Magento 2 Snippets
2+
3+
A nice start to a collection of Magento 2 code snippets for Visual Studio Code!
4+
5+
## Snippets
6+
7+
**Table of Contents**
8+
- Layouts
9+
- Base
10+
- Block
11+
- Block Wrap
12+
- Container
13+
- Container Wrap
14+
- Reference Block
15+
- Reference Container
16+
- Move
17+
- Remove
18+
- Update
19+
- Arguments
20+
- Argument

vsc-extension-quickstart.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)