@stati/core 1.23.0 → 1.23.1
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 +55 -54
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @stati/core
|
|
2
2
|
|
|
3
|
-
**The core engine powering Stati
|
|
3
|
+
**The core engine powering Stati - a minimal, TypeScript-first static site generator that's fast to learn and even faster to build with.**
|
|
4
4
|
|
|
5
5
|
Built for developers who want modern tooling without the complexity. Write in Markdown, template with Eta, and deploy anywhere.
|
|
6
6
|
|
|
@@ -85,18 +85,18 @@ That's it! Your site is ready.
|
|
|
85
85
|
|
|
86
86
|
### For New Users
|
|
87
87
|
|
|
88
|
-
- **Zero Configuration Required**
|
|
89
|
-
- **Simple File Structure**
|
|
90
|
-
- **Live Reload Built-In**
|
|
91
|
-
- **SEO Ready**
|
|
88
|
+
- **Zero Configuration Required** - Works out of the box with sensible defaults
|
|
89
|
+
- **Simple File Structure** - Markdown files automatically become pages
|
|
90
|
+
- **Live Reload Built-In** - See changes instantly during development
|
|
91
|
+
- **SEO Ready** - Automatic meta tags and structured data
|
|
92
92
|
|
|
93
93
|
### For Advanced Users
|
|
94
94
|
|
|
95
|
-
- **Programmatic API**
|
|
96
|
-
- **TypeScript-First**
|
|
97
|
-
- **TypeScript Compilation**
|
|
98
|
-
- **Extensible Hooks**
|
|
99
|
-
- **Smart Caching**
|
|
95
|
+
- **Programmatic API** - Full control over the build process
|
|
96
|
+
- **TypeScript-First** - Complete type safety for configuration
|
|
97
|
+
- **TypeScript Compilation** - Built-in esbuild for client-side TypeScript
|
|
98
|
+
- **Extensible Hooks** - Customize every stage of the build
|
|
99
|
+
- **Smart Caching** - Incremental builds with intelligent invalidation
|
|
100
100
|
|
|
101
101
|
---
|
|
102
102
|
|
|
@@ -217,7 +217,7 @@ This is all you need! Stati automatically enables:
|
|
|
217
217
|
|
|
218
218
|
### Extended Configuration (Common Options)
|
|
219
219
|
|
|
220
|
-
Below are commonly used configuration options. This is **not a complete list**
|
|
220
|
+
Below are commonly used configuration options. This is **not a complete list** - see the [full configuration documentation](https://stati.build/configuration/) for all available options.
|
|
221
221
|
|
|
222
222
|
```javascript
|
|
223
223
|
import { defineConfig } from '@stati/core';
|
|
@@ -451,11 +451,11 @@ Invalidate cache by tags, paths, patterns, or age.
|
|
|
451
451
|
|
|
452
452
|
**Query Syntax:**
|
|
453
453
|
|
|
454
|
-
- `tag:blog`
|
|
455
|
-
- `path:/posts`
|
|
456
|
-
- `glob:/blog/**`
|
|
457
|
-
- `age:3months`
|
|
458
|
-
- No query
|
|
454
|
+
- `tag:blog` - Invalidate pages with specific tag
|
|
455
|
+
- `path:/posts` - Invalidate pages under path
|
|
456
|
+
- `glob:/blog/**` - Invalidate by glob pattern
|
|
457
|
+
- `age:3months` - Invalidate content younger than 3 months
|
|
458
|
+
- No query - Clear entire cache
|
|
459
459
|
|
|
460
460
|
**Examples:**
|
|
461
461
|
|
|
@@ -564,11 +564,11 @@ import type {
|
|
|
564
564
|
|
|
565
565
|
Stati supports rich Markdown features out of the box:
|
|
566
566
|
|
|
567
|
-
- **Front-matter**
|
|
568
|
-
- **Plugins**
|
|
569
|
-
- **Syntax highlighting**
|
|
570
|
-
- **Custom rendering**
|
|
571
|
-
- **Draft mode**
|
|
567
|
+
- **Front-matter** - YAML, TOML, or JSON metadata
|
|
568
|
+
- **Plugins** - Full markdown-it ecosystem compatibility
|
|
569
|
+
- **Syntax highlighting** - Code blocks with language support
|
|
570
|
+
- **Custom rendering** - Configure parser behavior
|
|
571
|
+
- **Draft mode** - Mark pages as `draft: true`
|
|
572
572
|
|
|
573
573
|
**Example with plugins:**
|
|
574
574
|
|
|
@@ -588,11 +588,11 @@ export default defineConfig({
|
|
|
588
588
|
|
|
589
589
|
Powered by [Eta](https://eta.js.org) for fast, flexible templates:
|
|
590
590
|
|
|
591
|
-
- **Layouts**
|
|
592
|
-
- **Partials**
|
|
593
|
-
- **Custom filters**
|
|
594
|
-
- **Type-safe helpers**
|
|
595
|
-
- **Hot reload**
|
|
591
|
+
- **Layouts** - Template inheritance via `layout` property
|
|
592
|
+
- **Partials** - Reusable components
|
|
593
|
+
- **Custom filters** - Transform data in templates
|
|
594
|
+
- **Type-safe helpers** - Access page data with autocomplete
|
|
595
|
+
- **Hot reload** - See template changes instantly
|
|
596
596
|
|
|
597
597
|
**Template structure:**
|
|
598
598
|
|
|
@@ -617,10 +617,10 @@ Powered by [Eta](https://eta.js.org) for fast, flexible templates:
|
|
|
617
617
|
|
|
618
618
|
Automatic navigation hierarchy based on your file structure:
|
|
619
619
|
|
|
620
|
-
- **Auto-generated tree**
|
|
621
|
-
- **Breadcrumbs**
|
|
622
|
-
- **Custom ordering**
|
|
623
|
-
- **Index pages**
|
|
620
|
+
- **Auto-generated tree** - Reflects directory structure
|
|
621
|
+
- **Breadcrumbs** - Parent-child relationships
|
|
622
|
+
- **Custom ordering** - Use `order` in front-matter
|
|
623
|
+
- **Index pages** - Special handling for `index.md`
|
|
624
624
|
|
|
625
625
|
**Access in templates:**
|
|
626
626
|
|
|
@@ -644,21 +644,21 @@ Automatic navigation hierarchy based on your file structure:
|
|
|
644
644
|
|
|
645
645
|
Built for productivity:
|
|
646
646
|
|
|
647
|
-
- **Live reload**
|
|
648
|
-
- **Fast rebuilds**
|
|
649
|
-
- **Error overlay**
|
|
650
|
-
- **Static assets**
|
|
651
|
-
- **Source maps**
|
|
647
|
+
- **Live reload** - WebSocket-based instant updates
|
|
648
|
+
- **Fast rebuilds** - Only rebuild changed pages
|
|
649
|
+
- **Error overlay** - See build errors in browser
|
|
650
|
+
- **Static assets** - Served from `public/` directory
|
|
651
|
+
- **Source maps** - Debug with original code
|
|
652
652
|
|
|
653
653
|
### Caching & Performance
|
|
654
654
|
|
|
655
655
|
Smart caching for lightning-fast builds:
|
|
656
656
|
|
|
657
|
-
- **Modification tracking**
|
|
658
|
-
- **Incremental builds**
|
|
659
|
-
- **Tag invalidation**
|
|
660
|
-
- **TTL-based refresh**
|
|
661
|
-
- **Age-based rules**
|
|
657
|
+
- **Modification tracking** - Rebuild only changed files
|
|
658
|
+
- **Incremental builds** - Skip unchanged pages
|
|
659
|
+
- **Tag invalidation** - Update related content together
|
|
660
|
+
- **TTL-based refresh** - Control cache lifetime
|
|
661
|
+
- **Age-based rules** - Different TTL for old content
|
|
662
662
|
|
|
663
663
|
**Cache strategies:**
|
|
664
664
|
|
|
@@ -690,7 +690,8 @@ export default defineConfig({
|
|
|
690
690
|
baseUrl: 'https://docs.example.com',
|
|
691
691
|
},
|
|
692
692
|
markdown: {
|
|
693
|
-
|
|
693
|
+
// TOC and heading anchors are built-in (enabled by default)
|
|
694
|
+
plugins: ['container', 'footnote'],
|
|
694
695
|
},
|
|
695
696
|
});
|
|
696
697
|
```
|
|
@@ -744,11 +745,11 @@ export default defineConfig({
|
|
|
744
745
|
|
|
745
746
|
## Learn More
|
|
746
747
|
|
|
747
|
-
- [**Full Documentation**](https://stati.build)
|
|
748
|
-
- [**Configuration Guide**](https://stati.build/configuration/file/)
|
|
749
|
-
- [**API Reference**](https://stati.build/api/reference/)
|
|
750
|
-
- [**Examples**](https://stati.build/examples/list/)
|
|
751
|
-
- [**Contributing**](https://github.com/ianchak/stati/blob/main/CONTRIBUTING.md)
|
|
748
|
+
- [**Full Documentation**](https://stati.build) - Complete guides and tutorials
|
|
749
|
+
- [**Configuration Guide**](https://stati.build/configuration/file/) - All options explained
|
|
750
|
+
- [**API Reference**](https://stati.build/api/reference/) - Detailed API docs
|
|
751
|
+
- [**Examples**](https://stati.build/examples/list/) - Real-world projects
|
|
752
|
+
- [**Contributing**](https://github.com/ianchak/stati/blob/main/CONTRIBUTING.md) - Help improve Stati
|
|
752
753
|
|
|
753
754
|
---
|
|
754
755
|
|
|
@@ -756,19 +757,19 @@ export default defineConfig({
|
|
|
756
757
|
|
|
757
758
|
Stati Core is built on these principles:
|
|
758
759
|
|
|
759
|
-
- **Simplicity First**
|
|
760
|
-
- **Performance Matters**
|
|
761
|
-
- **Developer Experience**
|
|
762
|
-
- **Type Safety**
|
|
763
|
-
- **Extensibility**
|
|
760
|
+
- **Simplicity First** - Sensible defaults that just work
|
|
761
|
+
- **Performance Matters** - Fast builds, smart caching
|
|
762
|
+
- **Developer Experience** - Great tooling, clear errors
|
|
763
|
+
- **Type Safety** - TypeScript throughout
|
|
764
|
+
- **Extensibility** - Customize when you need to
|
|
764
765
|
|
|
765
766
|
---
|
|
766
767
|
|
|
767
768
|
## Support & Community
|
|
768
769
|
|
|
769
|
-
- [GitHub Issues](https://github.com/ianchak/stati/issues)
|
|
770
|
-
- [Discussions](https://github.com/ianchak/stati/discussions)
|
|
771
|
-
- [Documentation](https://stati.build)
|
|
770
|
+
- [GitHub Issues](https://github.com/ianchak/stati/issues) - Report bugs or request features
|
|
771
|
+
- [Discussions](https://github.com/ianchak/stati/discussions) - Ask questions, share ideas
|
|
772
|
+
- [Documentation](https://stati.build) - Comprehensive guides
|
|
772
773
|
|
|
773
774
|
---
|
|
774
775
|
|