Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor improvements #18

Merged
merged 3 commits into from
Sep 29, 2023
Merged

Minor improvements #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca62193
docs: improve link to Vike
lourot Sep 25, 2023
4a78eb4
qual: move comment
lourot Sep 25, 2023
ea7fb0c
qual: improve links to vike-solid
lourot Sep 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Build `vike-solid`:

```bash
git clone [email protected]:magne4000/vike-solid
git clone [email protected]:vikejs/vike-solid
cd vike-solid/ && pnpm install
pnpm build
cd ../
Expand Down
2 changes: 1 addition & 1 deletion examples/basic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Basic example of using `vike-solid`.

```bash
git clone [email protected]:magne4000/vike-solid
git clone [email protected]:vikejs/vike-solid
cd vike-solid/examples/basic/
pnpm install
pnpm run dev
Expand Down
2 changes: 1 addition & 1 deletion examples/ssr-spa/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Example of selecting SPA or SSR on a per-page basis. See
[SPA vs SSR (and more)](https://vike.dev/SPA-vs-SSR).

```bash
git clone [email protected]:magne4000/vike-solid
git clone [email protected]:vikejs/vike-solid
cd vike-solid/examples/ssr-spa/
npm install
npm run dev
Expand Down
5 changes: 2 additions & 3 deletions vike-solid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@

# `vike-solid`

SolidJS integration for [Vike](https://github.com/vikejs/vike/issues/736) (using the
[V1 design](https://vike.dev/migration/v1-design)).
SolidJS integration for [Vike](https://github.com/vikejs/vike) (using the [V1 design](https://vike.dev/migration/v1-design)).

> [!NOTE]
> For integrations with React and Vue, see the other [`vike-*` packages](https://vike.dev/vike-packages).

See [examples/](https://github.com/magne4000/vike-solid/tree/main/examples).
See [examples/](https://github.com/vikejs/vike-solid/tree/main/examples).
2 changes: 1 addition & 1 deletion vike-solid/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@
"bin": "./cli/entry.js",
"main": "dist/+config.js",
"types": "dist/renderer/+config.d.ts",
"repository": "github:magne4000/vike-solid",
"repository": "github:vikejs/vike-solid",
"license": "MIT"
}
2 changes: 1 addition & 1 deletion vike-solid/renderer/+config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import type { Config, ConfigEffect, PageContext } from "vike/types";
// We purposely define the ConfigVikeSolid interface in this file: that way we ensure it's always applied whenever the user `import vikeSolid from 'vike-solid'`
import type { Component } from "./types.js";

// Depending on the value of `config.meta.ssr`, set other config options' `env`
Expand Down Expand Up @@ -59,6 +58,7 @@ export default {
},
} satisfies Config;

// We purposely define the ConfigVikeSolid interface in this file: that way we ensure it's always applied whenever the user `import vikeSolid from 'vike-solid'`
declare global {
namespace VikePackages {
interface ConfigVikeSolid {
Expand Down