Skip to content

Commit

Permalink
docs: up
Browse files Browse the repository at this point in the history
  • Loading branch information
lvjiaxuan committed Sep 1, 2022
1 parent d9f6814 commit 4c2ec88
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 69 deletions.
21 changes: 17 additions & 4 deletions Guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,23 @@

[tasks.json](./.vscode/tasks.json)

# References
## Following extension guidelines

https://github1s.com/midnightsyntax/vscode-wrap-console-log
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

https://github1s.com/Box-Of-Hats/vscode-minify-selection/blob/HEAD/src/minifySelectionCommandProvider.ts#L12
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

https://github1s.com/gko/wrap
## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**
73 changes: 8 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,23 @@
# WIP

- [ ] select lines and disable it with:
- [ ] right click menu.
- [x] Cmd.
- [x] Keyboard shortcuts(ctrl+alt+d).
- [ ] snippets based on rules config.

***
# eslint-disable README

This is the README for your extension "eslint-disable". After writing up a brief description, we recommend including the following sections.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
- [x] Based on eslint's results of current file.
- [x] Select one or multiple lines, and disable it with:
- [ ] Right click menu.
- [x] Cmd(`eslint-disable.disableIT`).
- [x] Keyboard shortcuts(`ctrl` + `alt` + `d`).

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> 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.
> gif to be provided
## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
> Nothing special.
## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.
- [ ] `eslint-disable.enable`: Enable/disable this extension.

## Known Issues

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

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**

0 comments on commit 4c2ec88

Please sign in to comment.