Merge pull request #16 from stephannv/master

crystal-lang · Jun 3, 2023 · e3420f9 · e3420f9
2 parents f13e8ac + b5405e2
commit e3420f9
Show file tree

Hide file tree

Showing 4 changed files with 146 additions and 3 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,18 @@
+name: CI
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v3
+
+      - name: Install Crystal
+        uses: crystal-lang/install-crystal@v1
+
+      - name: Run tests
+        run: crystal spec
diff --git a/.github/workflows/weekly.yml b/.github/workflows/weekly.yml
@@ -0,0 +1,30 @@
+name: Weekly CI
+on:
+  schedule:
+    - cron: 0 0 * * 1 # At 00:00 on Monday
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - {os: ubuntu-latest, crystal: latest}
+          - {os: ubuntu-latest, crystal: nightly}
+          - {os: macos-latest}
+          - {os: windows-latest}
+
+    name: Tests
+    runs-on: ${{matrix.os}}
+    steps:
+      - name: Download source
+        uses: actions/checkout@v3
+
+      - name: Install Crystal
+        uses: crystal-lang/install-crystal@v1
+        with:
+          crystal: ${{matrix.crystal}}
+          shards: false
+
+      - name: Run tests
+        run: crystal spec
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ dependencies:
 
 ## Usage
 
-
+#### Basic usage
 ```crystal
 require "html_builder"
 
@@ -25,9 +25,105 @@ html = HTML.build do
   end
 end
 
-puts html # => %(<a href="http://crystal-lang.org">crystal is awesome</a>)
+puts html
+```
+
+**Output** (this output is formatted for better display):
+```html
+<a href="http://crystal-lang.org">
+  crystal is awesome
+</a>
+```
+
+
+#### Full HTML5 page
+```crystal
+html = HTML.build do
+  doctype
+  html(lang: "pt-BR") do
+    head do
+      title { text "Crystal Programming Language" }
+
+      meta(charset: "UTF-8")
+    end
+    body do
+      a(href: "http://crystal-lang.org") { text "Crystal rocks!" }
+      form(method: "POST") do
+        input(name: "name")
+      end
+    end
+  end
+end
+
+puts html
+```
+
+**Output** :
+```html
+<!DOCTYPE html>
+
+<html lang="pt-BR">
+  <head>
+    <title>Crystal Programming Language</title>
+
+    <meta charset="UTF-8">
+  </head>
+
+  <body>
+    <a href="http://crystal-lang.org">Crystal rocks!</a>
+    <form method="POST">
+      <input name="name">
+    </form>
+  </body>
+</html>
+```
+
+#### Custom tags
+
+```crystal
+html = HTML.build do
+  tag("v-button", to: "home") { text "Home" }
+end
+
+puts html
 ```
 
+**Output**:
+```html
+<v-button to="home">
+  Home
+</v-button>
+```
+
+#### Safety
+
+HTML::Builder escapes attribute values:
+```crystal
+html = HTML.build do
+  a(href: "<>") { }
+end
+
+puts html
+```
+
+**Output**:
+```html
+<a href="&lt;&gt;"></a>
+```
+
+And escapes text:
+```crystal
+html = HTML.build do
+  a { text "<>" }
+end
+
+puts html
+```
+
+**Output**:
+```html
+<a>&lt;&gt;</a>
+```
 ## Contributing
 
 1. Fork it ( https://github.com/crystal-lang/html_builder/fork )