kotlin

.gitignore

@@ -1,12 +1,15 @@
-_site/
+# General ignores
+.DS_Store
+build
+out
+kotlin-js-store
 
-javascript/node_modules/
-javascript/public/build/
+# IntelliJ ignores
+*.iml
+/*.ipr
 
-.idea/
-.bundle
-.jekyll-cache
-.sass-cache
-vendor
+/.idea
+
+# Gradle ignores
+.gradle
 
-.DS_Store

Guide.md

@@ -0,0 +1,122 @@
+---
+root: .components.layouts.MarkdownLayout("About")
+---
+
+# About this template
+
+This template is intended to both demonstrate some fundamentals of the Kobweb framework and act a starting point you can
+build your own site from.
+
+---
+
+## Learn
+
+If this is your first time using Kobweb, please open this site's project in an IDE and take a few minutes to look around
+the code.
+
+### Files
+
+#### AppEntry.kt
+
+This file declares a method that is an entry point for all pages on your site. You can rename the file and the method if
+you like. Kobweb searches for a single method at compile time annotated with `@App`.
+
+#### AppStyles.kt
+
+An example of declaring generally useful styles that can be used anywhere across the whole site. Otherwise, you normally
+declare styles close to the widget that uses them.
+
+#### SiteTheme.kt
+
+An example of how to define some site-specific colors, effectively extending the palette provided by Silk.
+
+#### components/
+
+By convention, Kobweb codebases organize reusable site components under this folder. Within it, you have:
+
+* `layout/`<br>
+  Represents top-level organization for pages
+* `sections/`<br>
+  Areas of content that appear across multiple pages (such as nav bars and footers)
+* `widgets/`<br>
+  Home for low-level UI pieces that you can use around your site
+
+#### pages/
+
+Any `@Composable` under this folder additionally tagged with `@Page` will have a route generated for it automatically.
+Defining a page outside of this folder will be flagged as an error by the Kobweb Gradle plugin at compile time. Note
+that additional pages (like this one!) might live under the `resources/markdown` folder.
+
+#### resources/
+
+* `public`<br>
+  If you want to host any media on your site (such as an icon, an image, text configuration files, movies, fonts, etc.),
+  you should put it under this folder.
+* `markdown`<br>
+  Any markdown discovered in here by Kobweb at compile time will be converted into pages on your site.
+
+### Classes
+
+The Kobweb and Silk APIs introduce a lot of powerful concepts. Here are some of the most important ones to know about
+which you can find used throughout this template.
+
+#### Modifier
+
+Kobweb introduces the `Modifier` keyword that Android developers will recognize from the Jetpack Compose API. In a
+webdev context, this is used for setting CSS styles and html attributes on elements in the page.
+
+#### ComponentStyle
+
+Traditional HTML pages use CSS to style their UI. In Kobweb, these styles can be declared using the `ComponentStyle`
+class in a Kotlin-idiomatic way. You can find examples of component styles used throughout the template.
+
+#### ComponentVariant
+
+You can generate variants from component styles, which are ways to take base component styles and tweak them further.
+
+#### Keyframes
+
+You can create animations by declaring keyframes for them.
+
+## Starting Point
+
+This template aims to create some generally useful pieces that most sites will want to use. Making your own site could
+be as easy as deleting this *About* page and working from there. However, you are welcome to modify or delete anything
+you find in the template that you don't plan to use in your final site.
+
+If instead you'd like to start from scratch, you can run
+
+```
+$ kobweb create app/empty
+```
+
+which will create a new project with nothing inside of it except for a minimal, skeletal structure.
+
+## Export and Deploy
+
+When you are ready to share your site with the world, you'll want to export it first. This will create a production
+snapshot of your site.
+
+There are two flavors of Kobweb sites: *static layout* and *full stack*. You
+can [read more about these choices here](https://github.com/varabyte/kobweb#static-layout-vs-full-stack-sites).
+
+For most sites, a static layout site is what you want, so to do that, return to the command line and run:
+
+```
+$ kobweb export --layout static
+```
+
+After that runs for a little while, your production site should be generated! You can find the files under the
+`.kobweb/site` folder.
+
+Test it locally by running:
+
+```
+$ kobweb run --layout static --env prod
+```
+
+If you're satisfied, you can upload your site files to the static website host provider of your choice. Each provider
+has its own instructions for how it discovers your files, so please refer to their documentation.
+
+You can [read this blog post](https://bitspittle.dev/blog/2022/staticdeploy) for some concrete examples of exporting a
+Kobweb site to two popular static website hosting providers.