Skip to content

Commit

Permalink
docs: add mermaid graph
Browse files Browse the repository at this point in the history
  • Loading branch information
webdiscus committed Oct 8, 2023
1 parent f4d37ea commit 7dae758
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This plugin is a modern solution for generating HTML containing JS, CSS, images,
The plugin allows to use [any template](#template-engine) file as [entry point](#option-entry).
In an HTML template can be referenced any source files, similar to how it works in [Vite](https://vitejs.dev/guide/#index-html-and-project-root) or [Parcel](https://parceljs.org/).

<!--
<table align="center">
<tr><th>Entry point is HTML</th></tr>
<tr><td><pre>
Expand All @@ -34,6 +35,20 @@ In an HTML template can be referenced any source files, similar to how it works
img font js css img
</pre></td></tr>
</table>
-->

```mermaid
graph TD
*(Entrypoint) ==>|Start from HTML|A[HTML]
A -->|source style file in HTML|D[CSS]
A -->|source image file in HTML|E[img]
A -->|source script file in HTML|F[JS]
D -.->|source image file in style|G[img]
D -.->|source font file in style|J[font]
F -.->K[JS]
F -.->|import style file in JS|L[CSS]
F -.->M[img]
```

#### See: [install and quick start](#install) | [contents](#contents) | [simple example](#example)

Expand Down
2 changes: 1 addition & 1 deletion examples/inline-svg-unique-id/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module.exports = {
params: {
// disable prefix as filename
prefix: false,
// enable unique ID for multiple inlining of the same SVG file containing IDs
// enable unique ID to avoid ID collision by inline multiple SVG files
uniqueId: true,
},
},
Expand Down

0 comments on commit 7dae758

Please sign in to comment.