@stonedeck/core 0.7.5 → 0.7.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 +51 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @stonedeck/core
|
|
2
|
+
|
|
3
|
+
> The engine that transforms Markdown into beautiful presentations
|
|
4
|
+
|
|
5
|
+
## What is this?
|
|
6
|
+
|
|
7
|
+
This is the core package of StoneDeck. It reads your Markdown files and converts them into a structured format that can be turned into HTML slides.
|
|
8
|
+
|
|
9
|
+
**You probably don't need to use this directly** - use the [@stonedeck/cli](../cli) instead for a better experience.
|
|
10
|
+
|
|
11
|
+
## When to use this
|
|
12
|
+
|
|
13
|
+
Use this package if you're:
|
|
14
|
+
- Building your own presentation tool on top of StoneDeck
|
|
15
|
+
- Creating a custom export format (not HTML)
|
|
16
|
+
- Integrating StoneDeck into another application
|
|
17
|
+
|
|
18
|
+
## Quick Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { processStoneDeck } from '@stonedeck/core';
|
|
22
|
+
import * as fs from 'fs';
|
|
23
|
+
|
|
24
|
+
// Read your markdown file
|
|
25
|
+
const content = fs.readFileSync('my-slides.md', 'utf-8');
|
|
26
|
+
|
|
27
|
+
// Convert to StoneDeck format
|
|
28
|
+
const presentation = processStoneDeck(content, 'my-slides.md');
|
|
29
|
+
|
|
30
|
+
// Now you have structured data ready to export
|
|
31
|
+
console.log(`Your presentation has ${presentation.slides.length} slides`);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## What's included
|
|
35
|
+
|
|
36
|
+
- Markdown parser for StoneDeck syntax
|
|
37
|
+
- Theme system (colors, fonts, backgrounds)
|
|
38
|
+
- Layout engine (title, content, cards, etc.)
|
|
39
|
+
- Smart content detection (tables, lists, images, code)
|
|
40
|
+
|
|
41
|
+
## Need help?
|
|
42
|
+
|
|
43
|
+
Check the main [StoneDeck documentation](../../README.md) or use the CLI tool directly.
|
|
44
|
+
|
|
45
|
+
## Repository
|
|
46
|
+
|
|
47
|
+
[https://github.com/matheuspellisoli/StoneDeck](https://github.com/matheuspellisoli/StoneDeck)
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|