paperastro 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -38
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,70 +1,64 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
|
+
# PaperAstro
|
|
2
3
|
|
|
3
4
|
PaperAstro is a lightweight, professional Astro starter template styled with PaperCSS.
|
|
4
5
|
It provides a clean, sketch‑inspired aesthetic while maintaining strong performance, clarity, and simplicity.
|
|
5
6
|
|
|
6
|
-
This template includes built‑in support for form handling through the Fabform
|
|
7
|
-
Learn more at: https://fabform.io
|
|
7
|
+
This template includes built‑in support for form handling through the Fabform backend.
|
|
8
|
+
Learn more at: [https://fabform.io](https://fabform.io)
|
|
8
9
|
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
9
13
|
|
|
10
14
|
### Install with npm (recommended)
|
|
11
15
|
|
|
16
|
+
```sh
|
|
12
17
|
npm create astro@latest -- --template @fabform/paperastro
|
|
18
|
+
```
|
|
13
19
|
|
|
20
|
+
This scaffolds a fresh project using the latest version of the PaperAstro starter.
|
|
21
|
+
You can explore npm installation.
|
|
14
22
|
|
|
15
|
-
|
|
23
|
+
### Install with Git
|
|
16
24
|
|
|
25
|
+
```sh
|
|
17
26
|
git clone https://github.com/fabformhub/paperastro
|
|
18
27
|
cd paperastro
|
|
19
28
|
npm install
|
|
20
29
|
npm run dev
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
You can explore Git installation.
|
|
33
|
+
|
|
34
|
+
---
|
|
21
35
|
|
|
22
36
|
## Screenshot
|
|
23
37
|
|
|
24
|
-
|
|
38
|
+
Image not displayed here.
|
|
39
|
+
You can explore screenshot usage.
|
|
40
|
+
|
|
41
|
+
---
|
|
25
42
|
|
|
26
43
|
## Demo
|
|
27
44
|
|
|
28
|
-
Live Demo: https://paperastro.vercel.app/
|
|
45
|
+
Live Demo: [https://paperastro.vercel.app/](https://paperastro.vercel.app/)
|
|
29
46
|
|
|
30
47
|
---
|
|
31
48
|
|
|
32
49
|
## Features
|
|
33
50
|
|
|
34
51
|
- Built with Astro 5
|
|
35
|
-
- Styled entirely with PaperCSS
|
|
52
|
+
- Styled entirely with PaperCSS
|
|
36
53
|
- MDX support included
|
|
37
54
|
- RSS and Sitemap integrations
|
|
38
55
|
- Sharp for image optimization
|
|
39
|
-
- Native form handling powered by
|
|
56
|
+
- Native form handling powered by Fabform
|
|
40
57
|
- Minimal, well‑structured project layout
|
|
41
58
|
- Suitable for blogs, documentation, and lightweight content sites
|
|
42
59
|
|
|
43
60
|
---
|
|
44
61
|
|
|
45
|
-
## Installation
|
|
46
|
-
|
|
47
|
-
### Install via npm (recommended)
|
|
48
|
-
|
|
49
|
-
You can scaffold a new PaperAstro project directly from npm:
|
|
50
|
-
|
|
51
|
-
```sh
|
|
52
|
-
npm create astro@latest -- --template @fabform/paperastro
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
This will generate a fresh project using the latest version of the PaperAstro starter.
|
|
56
|
-
|
|
57
|
-
### Install from GitHub
|
|
58
|
-
|
|
59
|
-
```sh
|
|
60
|
-
git clone https://github.com/fabformhub/paperastro
|
|
61
|
-
cd paperastro
|
|
62
|
-
npm install
|
|
63
|
-
npm run dev
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
---
|
|
67
|
-
|
|
68
62
|
## Project Structure
|
|
69
63
|
|
|
70
64
|
```
|
|
@@ -79,6 +73,8 @@ npm run dev
|
|
|
79
73
|
└── package.json
|
|
80
74
|
```
|
|
81
75
|
|
|
76
|
+
You can explore project structure.
|
|
77
|
+
|
|
82
78
|
---
|
|
83
79
|
|
|
84
80
|
## Commands
|
|
@@ -89,11 +85,13 @@ npm run build # Build the site for production
|
|
|
89
85
|
npm run preview # Preview the production build
|
|
90
86
|
```
|
|
91
87
|
|
|
88
|
+
You can explore Astro commands.
|
|
89
|
+
|
|
92
90
|
---
|
|
93
91
|
|
|
94
92
|
## Form Handling with Fabform
|
|
95
93
|
|
|
96
|
-
PaperAstro includes ready‑to‑use form integration powered by the Fabform
|
|
94
|
+
PaperAstro includes ready‑to‑use form integration powered by the Fabform backend.
|
|
97
95
|
You can connect any form by adding your Fabform endpoint URL.
|
|
98
96
|
|
|
99
97
|
Learn more at: [https://fabform.io](https://fabform.io)
|
|
@@ -102,9 +100,9 @@ Learn more at: [https://fabform.io](https://fabform.io)
|
|
|
102
100
|
|
|
103
101
|
## Deploy with Vercel
|
|
104
102
|
|
|
105
|
-
|
|
103
|
+
Deploy PaperAstro to Vercel with one click:
|
|
106
104
|
|
|
107
|
-
Deploy with Vercel
|
|
105
|
+
[](https://vercel.com/new/clone?repository-url=https://github.com/fabformhub/paperastro)
|
|
108
106
|
|
|
109
107
|
---
|
|
110
108
|
|
|
@@ -121,9 +119,7 @@ GitHub: [https://github.com/fabformhub/paperastro](https://github.com/fabformhub
|
|
|
121
119
|
|
|
122
120
|
## npm Package
|
|
123
121
|
|
|
124
|
-
|
|
125
|
-
|
|
122
|
+
[https://www.npmjs.com/package/@fabform/paperastro](https://www.npmjs.com/package/@fabform/paperastro)
|
|
123
|
+
You can explore the npm package.
|
|
126
124
|
|
|
127
125
|
---
|
|
128
|
-
|
|
129
|
-
If you want a **badge row**, **hero header**, or **CHANGELOG.md**, I can generate those in the same clean, uninterrupted format.
|
package/package.json
CHANGED