@san-siva/blogkit 1.1.5 → 1.1.6
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 +12 -4
- package/dist/cjs/index.css +1 -1
- package/dist/cjs/index.css.map +1 -1
- package/dist/esm/index.css +1 -1
- package/dist/esm/index.css.map +1 -1
- package/package.json +69 -69
- package/src/styles/Blog.module.scss +1 -4
package/README.md
CHANGED
|
@@ -33,12 +33,14 @@ pnpm add @san-siva/blogkit
|
|
|
33
33
|
|
|
34
34
|
### Peer Dependencies
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
npm 7+ will automatically prompt you to install peer dependencies. If you need to install them manually:
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
npm install
|
|
39
|
+
npm install @react-spring/web mermaid prismjs react-syntax-highlighter
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
**Note:** Blogkit also requires `react@^19.0.0`, `react-dom@^19.0.0`, and `next@^16.0.10`, which are typically already installed in Next.js projects.
|
|
43
|
+
|
|
42
44
|
## Quick Start
|
|
43
45
|
|
|
44
46
|
### 1. Import Styles
|
|
@@ -51,13 +53,19 @@ import '@san-siva/blogkit/styles.css';
|
|
|
51
53
|
```
|
|
52
54
|
|
|
53
55
|
**Why is this required?**
|
|
54
|
-
|
|
56
|
+
|
|
57
|
+
Blogkit pre-compiles its SCSS modules into CSS at build time. This approach provides several benefits:
|
|
58
|
+
- **No Sass dependency** - You don't need to install Sass in your project
|
|
59
|
+
- **Faster builds** - CSS is already compiled, no SCSS processing needed
|
|
60
|
+
- **Better compatibility** - Avoids conflicts with different Sass versions
|
|
61
|
+
|
|
62
|
+
The `styles.css` import provides:
|
|
55
63
|
- All component styles (Blog, CodeBlock, Mermaid, Table, Callout, etc.)
|
|
56
64
|
- Responsive design rules
|
|
57
65
|
- Theme variables and custom properties
|
|
58
66
|
- Critical layout styles
|
|
59
67
|
|
|
60
|
-
Without this import, components will render
|
|
68
|
+
Without this import, components will render unstyled.
|
|
61
69
|
|
|
62
70
|
### 2. Use Components
|
|
63
71
|
|