|
1 | | -# Astro Theme Pure |
2 | | - |
3 | | -[English](./README.md) | [简体中文](./README-zh-CN.md) |
4 | | - |
5 | | -A simple, fast and powerful blog theme built by Astro. |
6 | | - |
7 | | -[](https://astro-pure.js.org/) |
8 | | -[](https://www.npmjs.com/package/astro-pure) |
9 | | -[](https://github.com/cworld1/astro-theme-pure/releases) |
10 | | -[](https://github.com/cworld1/astro-theme-pure/blob/main/LICENSE) |
11 | | - |
12 | | - |
13 | | - |
14 | | - |
15 | | -> [!WARNING] |
16 | | -> Theme template v4.0.2^ is changing CSS engine to UnoCSS. Stabler experience is currently on [v4.0.1-beta](https://github.com/cworld1/astro-theme-pure/tree/v4.0.1-beta). Known issues: |
17 | | -> |
18 | | -> 1. UnoCSS adaption (serious) |
19 | | -> 2. Cannot pack sitemap and pagefind resources on Vercel ([need upstream fix](https://github.com/withastro/astro/issues/12663) & temp fixed) |
20 | | -> 3. Header & customize options is still under development (template exposed still) |
21 | | -
|
22 | | -## Introduction |
23 | | - |
24 | | -Checkout [Demo Site →](https://astro-pure.js.org/) |
25 | | - |
26 | | -### :fire: Features |
27 | | - |
28 | | -- [x] :rocket: Fast & high performance |
29 | | -- [x] :star: Simple & clean design |
30 | | -- [x] :iphone: Responsive design |
31 | | -- [x] :mag: Full-site search built with [pagefind](https://pagefind.app/) |
32 | | -- [x] :world_map: Sitemap & RSS feed |
33 | | -- [x] :spider_web: SEO-friendly |
34 | | -- [x] :book: TOC (table of contents) |
35 | | -- [x] :framed_picture: Dynamic open graph generation for posts |
36 | | -- [x] :framed_picture: Mediumzoom lightbox for images |
37 | | - |
38 | | -### :package: Components |
39 | | - |
40 | | -Theme includes a lot of components, which can not only be used in the theme, but also in other astro projects. |
41 | | - |
42 | | -> For other astro projects, UnoCSS is required. |
43 | | -
|
44 | | -- Basic components: `Aside`, `Tabs`, `Timeline`, `Steps`, `Spoiler`... |
45 | | -- Advanced components: `GithubCard`, `LinkPreview`, `Quote`, `QRCode`... |
46 | | - |
47 | | -### :white_check_mark: Lighthouse score |
48 | | - |
49 | | -[](https://pagespeed.web.dev/analysis/https-cworld-top/o229zrt5o4?form_factor=mobile&hl=en) |
50 | | - |
51 | | -## Documentation |
52 | | - |
53 | | -[Docs](https://astro-pure.js.org/docs) | [Showcase](https://github.com/cworld1/astro-theme-pure/issues/10) |
54 | | - |
55 | | -## Package |
56 | | - |
57 | | -See [astro-theme-pure](https://www.npmjs.com/package/astro-pure) on npm. |
58 | | - |
59 | | -## Local development |
60 | | - |
61 | | -Environment requirements: |
62 | | - |
63 | | -- [Nodejs](https://nodejs.org/): 18.0.0+ |
64 | | - |
65 | | -Clone the repository: |
66 | | - |
67 | | -```shell |
68 | | -git clone https://github.com/cworld1/astro-theme-pure.git |
69 | | -cd astro-theme-pure |
70 | | -``` |
71 | | - |
72 | | -Useful commands: |
73 | | - |
74 | | -```shell |
75 | | -# install dependencies |
76 | | -bun install |
77 | | - |
78 | | -# start the dev server |
79 | | -bun dev |
80 | | - |
81 | | -# build the project |
82 | | -bun run build |
83 | | - |
84 | | -# preview (after the build) |
85 | | -bun preview |
86 | | - |
87 | | -# create a new post |
88 | | -bun new-post |
89 | | -``` |
90 | | - |
91 | | -## Contributions |
92 | | - |
93 | | -To spend more time coding and less time fiddling with whitespace, this project uses code conventions and styles to encourage consistency. Code with a consistent style is easier (and less error-prone!) to review, maintain, and understand. |
94 | | - |
95 | | -## Thanks |
96 | | - |
97 | | -- [Astro Cactus](https://github.com/chrismwilliams/astro-theme-cactus) |
98 | | -- [Astro Resume](https://github.com/srleom/astro-theme-resume) |
99 | | -- [Starlight](https://github.com/withastro/starlight) |
100 | | - |
101 | | -## License |
102 | | - |
103 | | -This project is licensed under the Apache 2.0 License. |
104 | | - |
105 | | -[](https://star-history.com/#cworld1/astro-theme-pure&Date) |
| 1 | +Blog powered by Astro Pure |
0 commit comments