You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,31 @@
1
-
# renderobjects
1
+
# RenderObjects.com
2
+
Articles and guides to help developers create their own `RenderObject`s.
2
3
3
-
A documentation site built with Jaspr
4
+
## Local Development
4
5
5
-
## Running the project
6
+
Install the Jaspr CLI:
7
+
```sh
8
+
dart pub global activate jaspr_cli
9
+
```
6
10
7
-
Run your project using `jaspr serve`.
8
11
9
-
The development server will be available on `http://localhost:8080`.
12
+
## Build
13
+
```sh
14
+
jaspr build
15
+
```
10
16
11
-
## Building the project
17
+
Output is written to `build/jaspr/`.
12
18
13
-
Build your project using `jaspr build`.
19
+
## Serve Locally
20
+
```sh
21
+
jaspr serve
22
+
```
23
+
24
+
Available locally at `http://localhost:8080`.
25
+
26
+
## Deploy to Production
27
+
28
+
Merging to `main` automatically builds and deploys the site to [renderobjects.com](https://renderobjects.com) via GitHub Actions and GitHub Pages.
29
+
30
+
To deploy, open a PR against `main` and merge it. The deployment workflow runs on every push to `main`; progress is visible under the repo's **Actions** tab.
14
31
15
-
The output will be located inside the `build/jaspr/` directory.
0 commit comments