Skip to content

Commit

Permalink
Merge pull request #894 from thefrontside/tm/add-vscode-workspace-wor…
Browse files Browse the repository at this point in the history
…karound

Make it easier to contribute to www with VSCode
  • Loading branch information
taras authored Feb 15, 2024
2 parents 8c5c21a + a68d6f5 commit 9dce9eb
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"deno.enable": true
"deno.enable": true,
"files.exclude": {
"www": true
}
}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ solid _at scale_, and it does all of this while feeling like normal JavaScript.
Effection runs on all major JavaScript platforms including NodeJs, Browser, and
Deno. It is published on both [npm][npm-effection] and [deno.land][deno-land-effection].

## Contributing to Website

Go to [www/README.md] to learn how to contribute to the website.

## Development

[Deno][] is the primary tool used for development, testing, and packaging.
Expand Down
3 changes: 3 additions & 0 deletions www/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"deno.enable": true,
}
11 changes: 11 additions & 0 deletions www/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
## Effection Website

The Effection website contains Guides and API documentation.

### Contributing

#### Using VSCode

The local development workflow with VSCode was adapted to workaround a [bug in Deno VSCode plugin][vscode-bug].
To get all of the VSCode niceties, you have to open the `www/www.code-workspace` using _File -> Open Workspace From File_.

### Development

```shellsession
$ deno task dev
```

[vscode-bug]: https://github.com/thefrontside/effection/issues/893
13 changes: 13 additions & 0 deletions www/www.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"folders": [
{
"name": "website",
"path": "."
},
{
"name": "core",
"path": "..",
},
],
"settings": {}
}

0 comments on commit 9dce9eb

Please sign in to comment.