rename to scaffolder

CHANGELOG.md

@@ -1,4 +1,4 @@
-# [unreleased](https://github.com/wisp3rwind/typst-show-the-frame/releases/tag/<tag>)
+# [unreleased](https://github.com/wisp3rwind/typst-scaffolder/releases/tag/<tag>)
 
 ## Added
 
@@ -9,9 +9,9 @@
 ## Migration Guide from v0.1.x
 
 
-# [v0.1.1](https://github.com/wisp3rwind/typst-show-the-frame/releases/tag/v0.1.1)
+# [v0.1.1](https://github.com/wisp3rwind/typst-scaffolder/releases/tag/v0.1.1)
 - Support all possible `page.margin` specifications
 
 
-# [v0.1.0](https://github.com/wisp3rwind/typst-show-the-frame/releases/tag/v0.1.0)
+# [v0.1.0](https://github.com/wisp3rwind/typst-scaffolder/releases/tag/v0.1.0)
 Initial release

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 - Create a PR against the typst packages repository
 - prepend a new section to the changelog and commit it:
   ```
-  # [unreleased](https://github.com/wisp3rwind/typst-show-the-frame/releases/tag/<tag>)
+  # [unreleased](https://github.com/wisp3rwind/typst-scaffolder/releases/tag/<tag>)
 
   ## Added
 

README.md

@@ -1,6 +1,6 @@
-[![Tests](https://github.com/wisp3rwind/typst-show-the-frame/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/wisp3rwind/typst-show-the-frame/actions/workflows/tests.yml)
+[![Tests](https://github.com/wisp3rwind/typst-scaffolder/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/wisp3rwind/typst-scaffolder/actions/workflows/tests.yml)
 
-# The `show-the-frame` Package
+# The `scaffolder` Package
 
 Show borders around the main text area, header and footer in Typst documents.
 
@@ -11,17 +11,17 @@ package.
 ## Usage
 
 ```typst
-#import "@preview/show-the-frame:v0.1.1": background
+#import "@preview/scaffolder:v0.2.0": scaffolding
 #set page(paper: "a6")
 
-#set page(background: background())
+#set page(background: scaffolding())
 
 #lorem(100)
 
 #pagebreak()
 
 #set page(
-  background: background(stroke: blue + 1pt),
+  background: scaffolding(stroke: blue + 1pt),
   columns: 2,
 )
 

docs/example-1.typ

@@ -1,15 +1,15 @@
 // This is the README example
-#import "/src/lib.typ": background
+#import "/src/lib.typ": scaffolding
 #set page(paper: "a6")
 
-#set page(background: background())
+#set page(background: scaffolding())
 
 #lorem(100)
 
 #pagebreak()
 
 #set page(
-  background: background(stroke: blue + 1pt),
+  background: scaffolding(stroke: blue + 1pt),
   columns: 2,
 )
 

src/impl.typ

@@ -165,7 +165,7 @@
 )
 
 // Display lines around the main text area, header and footer.
-#let background(
+#let scaffolding(
   stroke: __default-stroke,
 ) = context {
   let margins = get-page-margins()

src/lib.typ

@@ -1,4 +1,4 @@
 // Only expose a limited number of symbols:
 // - the main user-facing function, as well as some helpers that might be useful
 //   to package authors
-#import "impl.typ": background, get-text-dir, get-page-binding, get-page-margins
+#import "impl.typ": scaffolding, get-text-dir, get-page-binding, get-page-margins

tests/col2/test.typ

@@ -1,8 +1,8 @@
 #import "/tests/helper.typ": test-rect
-#import "/src/lib.typ": background
+#import "/src/lib.typ": scaffolding
 
 #set page(
-  background: background(),
+  background: scaffolding(),
   footer: test-rect(fill: red),
   header: test-rect(fill: green),
   paper: "a6",

tests/margin-specs/test.typ

@@ -1,9 +1,9 @@
 #import "/tests/helper.typ": test-rect
 #import "/src/impl.typ": get-page-binding, get-page-margins, get-text-dir
-#import "/src/lib.typ": background
+#import "/src/lib.typ": scaffolding
 
 #set page(
-  background: background(),
+  background: scaffolding(),
   // Fill header, footer, ...
   footer: test-rect(fill: red),
   header: test-rect(fill: green),

typst.toml

@@ -1,8 +1,8 @@
 [package]
-name = "show-the-frame"
+name = "scaffolder"
 version = "0.1.1"
 compiler = "0.12.0"
-repository = "https://github.com/wisp3rwind/typst-show-the-frame"
+repository = "https://github.com/wisp3rwind/typst-scaffolder"
 entrypoint = "src/lib.typ"
 authors = [
   "wisp3rwind <@wisp3rwind>"