Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
hridniev committed Jun 3, 2024
2 parents 86f8667 + 478772b commit 8134c71
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 23 deletions.
14 changes: 11 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ export default {
```
{% endcode %}

4.Install and configure [TailwindCSS](https://tailwindcss.com/docs/guides/vite#vue) (if not) and add `vuelessPreset` for it.
4.Install and configure [TailwindCSS](https://tailwindcss.com/docs/guides/vite#vue) (if not) and add `vuelessPreset` to it.

<pre class="language-javascript" data-title="tailwind.config.js"><code class="lang-javascript"><strong>import { vuelessPreset } from "vueless/preset.tailwind";
<pre class="language-javascript" data-title="tailwind.config.js"><code class="lang-javascript"><strong>import { vuelessPreset } from "vueless/preset.tailwind.js";
</strong>
export default {
presets: [vuelessPreset],
Expand All @@ -80,7 +80,15 @@ export default defineConfig({
```
{% endcode %}

That's it! You can use components in your app now ✨
6\. Migrate you project to ECMAScript modules (ESM).

<pre class="language-javascript" data-title="package.json"><code class="lang-javascript"><strong>{
</strong> "type": "module",
...
}
</code></pre>

That's it! You can use Vueless in your app now ✨

### Minimal requirements

Expand Down
3 changes: 2 additions & 1 deletion docs/advanced/local-storybook-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ yarn add -D @vueless/storybook

{% tab title="pnpm" %}
```bash
pnpm add -D @vueless/storybook
pnpm add -D @vueless/storybook --pnpm
```
{% endtab %}

Expand All @@ -50,6 +50,7 @@ Which:

* creates `.storybook` config folder in the root of the project.
* adds commands into the project `package.json` to run and build Storybook locally.
* creates `.npmrc` config for `pnpm` only.

{% hint style="info" %}
If the `.storybook` folder is exist the package backup it before copying as a `.storybook-{timestamp}`.
Expand Down
1 change: 1 addition & 0 deletions docs/advanced/web-types-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ But, in some cases you may need to install [`@vueless/web-types`](https://www.n

**When you may need to install it:**

* If you going to change default values for props in `vueless.config.js`.
* If you going to use Vue components from the `/component` folder without importing them (unplugin) to remove IDE warnings.
* If you using JSDoc for documenting custom components and want to see props description and autocompletion on the go.

Expand Down
17 changes: 1 addition & 16 deletions docs/installation/possible-issues.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,6 @@
# Possible issues

### 1. SyntaxError: Unexpected token 'export'

```bash
/[root dir path]/vueless.config.js:6
export default {
^^^^^^

SyntaxError: Unexpected token 'export'
...
```
<mark style="color:green;">**Solution:**</mark> add `"type": "module"` in your project `package.json`
***
### 2. SyntaxError: The requested module '/node\_modules/tailwindcss/colors.js?v=...' does not provide an export named 'default'
### 1. SyntaxError: The requested module '/node\_modules/tailwindcss/colors.js?v=...' does not provide an export named 'default'

<mark style="color:green;">**Solution:**</mark> add `optimizeDeps` to the project `vite.config`.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vueless",
"version": "0.0.127",
"version": "0.0.128",
"license": "MIT",
"description": "Vue Styleless Component Framework.",
"homepage": "https://vueless.com",
Expand Down

0 comments on commit 8134c71

Please sign in to comment.