add page describing how to add static assets

yewstack · Feb 28, 2020 · 6446d6f · 6446d6f
1 parent 37c24db
commit 6446d6f
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 7 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -33,7 +33,7 @@
 
 ## More
 
-* [CSS](more/css.md)
+* [Static Content](more/static.md)
 * [Roadmap](more/roadmap.md)
 * [Testing](more/testing.md)
 * [External Libs](more/external-libs.md)

diff --git a/src/more/css.md b/src/more/css.md
diff --git a/src/more/static.md b/src/more/static.md
@@ -0,0 +1,42 @@
+# Static Content
+
+Static content in Yew is served from the `static` directory in your crate. For example, if you have a folder structure like:
+
+```
+myapp
+├── src/
+│   └── lib.rs
+├── static/
+│   └── script.js
+├── Cargo.lock
+└── Cargo.toml
+```
+
+## HTML
+
+Yew compiles to a single-page application, with one JavaScript bundle that can be imported into an HTML page. Yew generates boilerplate HTML page out of the box, but you can create a custom one in `static/index.html` if you wish to override this.
+
+Your application will be built at `/crate.js`. For example, for your custom HTML page that imports some CSS, you might have:
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>My Awesome App!</title>
+  <!-- references /static/mystyles.css -->
+  <link rel="stylesheet" href="/mystyles.css">
+</head>
+<body>
+  <script src="/myapp.js"></script>
+</body>
+</html>
+```
+
+## CSS
+
+A proposal for proper CSS support can be found here: [https://github.com/yewstack/yew/issues/533](https://github.com/yewstack/yew/issues/533).
+
+For now, you can reference stylesheets be creating a custom `index.html` within the `static` directory.
+