Skip to content

Commit 666208e

Browse files
committed
Document how to use plugin with regular Visual Studio
Fixes microsoft#4
1 parent 8b7ee3e commit 666208e

File tree

2 files changed

+89
-50
lines changed

2 files changed

+89
-50
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TypeScript server plugin that adds intellisense to [styled component](https://st
77
[![Build Status](https://travis-ci.org/Microsoft/typescript-styled-plugin.svg?branch=master)](https://travis-ci.org/Microsoft/typescript-styled-plugin)
88

99
## Usage
10-
This plugin requires TypeScript 2.4 or later. It can provide intellisense in both JavaScript and TypeScript files within any editor that uses TypeScript to power their language features. This includes [VS Code](https://code.visualstudio.com), [Sublime with the TypeScript plugin](https://github.com/Microsoft/TypeScript-Sublime-Plugin), [Atom with the TypeScript plugin](https://atom.io/packages/atom-typescript), and others.
10+
This plugin requires TypeScript 2.4 or later. It can provide intellisense in both JavaScript and TypeScript files within any editor that uses TypeScript to power their language features. This includes [VS Code](https://code.visualstudio.com), [Sublime with the TypeScript plugin](https://github.com/Microsoft/TypeScript-Sublime-Plugin), [Atom with the TypeScript plugin](https://atom.io/packages/atom-typescript), [Visual Studio](https://www.visualstudio.com), and others.
1111

1212
### With VS Code
1313
To use this plugin with VS Code, first install the plugin and a copy of TypeScript in your workspace:
@@ -92,6 +92,32 @@ Then add a `plugins` section to your [`tsconfig.json`](http://www.typescriptlang
9292
To get sytnax highlighting for styled strings in Atom, consider installing the [language-babel](https://atom.io/packages/language-babel) extension.
9393

9494

95+
### With Atom
96+
This plugin works [Visual Studio 2017](https://www.visualstudio.com) using the TypeScript 2.5+ SDK.
97+
98+
First install the plugin in your project:
99+
100+
```bash
101+
npm install --save-dev typescript-styled-plugin
102+
```
103+
104+
Then add a `plugins` section to your [`tsconfig.json`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or [`jsconfig.json`](https://code.visualstudio.com/Docs/languages/javascript#_javascript-project-jsconfigjson) and restart Atom.
105+
106+
```json
107+
{
108+
"compilerOptions": {
109+
"plugins": [
110+
{
111+
"name": "typescript-styled-plugin"
112+
}
113+
]
114+
}
115+
}
116+
```
117+
118+
Then reload your project to make sure the plugin has been loaded properly.
119+
120+
95121
## Configuration
96122

97123
### Tags

package-lock.json

+62-49
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)