Skip to content

Commit 5c511a4

Browse files
wip(docs): enhancements
1 parent 7aece11 commit 5c511a4

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Load .vue files dynamically at runtime from your html/js. No node.js environment
7777

7878
## Public API documentation
7979

80-
**[loadModule](docs/api/README.md#loadmodule)**(`path`: string, `options`: [Options](docs/api/interfaces/options.md)): `Promise<VueComponent>`
80+
**[loadModule](docs/api/README.md#loadmodule)**(`path`: string, `options`: [Options](/docs/api/README.md#options)): `Promise<VueComponent>`
8181

8282

8383
## dist/
@@ -123,6 +123,9 @@ Load .vue files dynamically at runtime from your html/js. No node.js environment
123123
_see [`package.json`](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/main/package.json) "build" script_
124124
_see [browserslist queries](https://github.com/browserslist/browserslist#queries)_
125125

126+
**preliminary steps:**
127+
1. clone `vue3-sfc-loader`
128+
1. run `yarn add`
126129

127130
## How It Works
128131

docs/faq.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# FAQ
22

3+
## Can I use vue3-sfc-loader source code directly (./src/index.ts)
4+
5+
Loading from sources "vue3-sfc-loader/src/index" will not work. Sources are intended to be processed by webpack before being usable.
6+
7+
8+
Note that you can [build vue3-sfc-loader yourself](https://github.com/FranckFreiburger/vue3-sfc-loader#build-your-own-version).
9+
10+
311
## How to use 3rd party plugins or components
412

513
#### From a `<script>` tag

0 commit comments

Comments
 (0)