Skip to content

Commit 0a0e561

Browse files
authored
Merge pull request #3 from brettkolodny/brett/readme
Brett/readme
2 parents 2afd2a5 + ddf96b8 commit 0a0e561

File tree

6 files changed

+706
-55
lines changed

6 files changed

+706
-55
lines changed

.github/assets/images/hero-image.png

129 KB
Loading

.github/assets/images/logo-black.png

2.09 KB
Loading

.github/assets/images/logo-white.png

2.09 KB
Loading

LICENSE

Lines changed: 661 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 44 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,44 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
13-
14-
```js
15-
export default tseslint.config({
16-
extends: [
17-
// Remove ...tseslint.configs.recommended and replace with this
18-
...tseslint.configs.recommendedTypeChecked,
19-
// Alternatively, use this for stricter rules
20-
...tseslint.configs.strictTypeChecked,
21-
// Optionally, add this for stylistic rules
22-
...tseslint.configs.stylisticTypeChecked,
23-
],
24-
languageOptions: {
25-
// other options...
26-
parserOptions: {
27-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
28-
tsconfigRootDir: import.meta.dirname,
29-
},
30-
},
31-
})
32-
```
33-
34-
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
35-
36-
```js
37-
// eslint.config.js
38-
import reactX from 'eslint-plugin-react-x'
39-
import reactDom from 'eslint-plugin-react-dom'
40-
41-
export default tseslint.config({
42-
plugins: {
43-
// Add the react-x and react-dom plugins
44-
'react-x': reactX,
45-
'react-dom': reactDom,
46-
},
47-
rules: {
48-
// other rules...
49-
// Enable its recommended typescript rules
50-
...reactX.configs['recommended-typescript'].rules,
51-
...reactDom.configs.recommended.rules,
52-
},
53-
})
54-
```
1+
<!-- markdownlint-disable MD041 -->
2+
<div align="center">
3+
<a href="https://coder.com#gh-light-mode-only">
4+
<img src="./.github/assets/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">
5+
</a>
6+
<a href="https://coder.com#gh-dark-mode-only">
7+
<img src="./.github/assets/images/logo-white.png" alt="Coder Logo Dark" style="width: 128px">
8+
</a>
9+
10+
<h1>
11+
Interactive Template Editor
12+
</h1>
13+
14+
<br>
15+
<br>
16+
17+
[Coder Repo](https://github.com/coder/coder) |
18+
[Docs](https://coder.com/docs) |
19+
[Why Coder](https://coder.com/why) |
20+
[Premium](https://coder.com/pricing#compare-plans)
21+
22+
[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)
23+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9511/badge)](https://www.bestpractices.dev/projects/9511)
24+
[![license](https://img.shields.io/github/license/coder/preview)](./LICENSE)
25+
26+
</div>
27+
28+
<!--Should update this with the new cool form options -->
29+
<p align="center">
30+
<img src="./.github/assets/images/hero-image.png" alt="Coder Hero Image">
31+
</p>
32+
33+
<!-- TODO: Add a usage section that links to coder/coder doc for how to use the `preview` command in coder cli -->
34+
35+
## Support
36+
37+
Do you have a workspace template that has incorrect parameters? Please open
38+
[workspace template behavior issue](https://github.com/coder/preview/issues/new?template=workspace-template-bug-report.md).
39+
40+
For other bugs, feature requests, etc, feel free to
41+
[open an issue](https://github.com/coder/preview/issues/new).
42+
43+
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress
44+
features and chat with the community using Coder!

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<link rel="stylesheet" href="src/index.css" />
1717
</head>
1818

19-
<body class="">
19+
<body class="dark">
2020
<div id="root"></div>
2121
<script type="module" src="/src/main.tsx"></script>
2222
</body>

0 commit comments

Comments
 (0)