@pinkpixel/marzipan 1.0.5
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/LICENSE +201 -0
- package/README.md +133 -0
- package/dist/favicon.png +0 -0
- package/dist/index.js +3212 -0
- package/dist/index.js.map +1 -0
- package/dist/logo.png +0 -0
- package/docs/README.md +33 -0
- package/docs/TABLE_OF_CONTENTS.md +19 -0
- package/docs/api.md +749 -0
- package/docs/plugins.md +57 -0
- package/docs/quick-start.md +90 -0
- package/docs/types.d.ts +231 -0
- package/package.json +66 -0
package/dist/logo.png
ADDED
|
Binary file
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Marzipan Documentation Portal
|
|
2
|
+
|
|
3
|
+
Welcome! This folder contains everything you need to install, configure, and extend the Marzipan markdown editor.
|
|
4
|
+
|
|
5
|
+
## 📚 Navigation
|
|
6
|
+
|
|
7
|
+
| Guide | Purpose |
|
|
8
|
+
|-------|---------|
|
|
9
|
+
| [Quick Start](./quick-start.md) | Install the library, render your first editor, and wire up bundled actions and plugins. |
|
|
10
|
+
| [API Reference](./api.md) | Full class API, key options, utility methods, and action helper signatures. |
|
|
11
|
+
| [Plugin Catalogue](./plugins.md) | Overview of the first-party plugins shipped from `src/plugins` with configuration tips. |
|
|
12
|
+
| [Type Definitions](./types.d.ts) | Generated TypeScript declarations for deep integration and tooling. |
|
|
13
|
+
|
|
14
|
+
## 🧭 Orientation
|
|
15
|
+
|
|
16
|
+
- **Actions live here now** – All formatting helpers are part of the core package (`@pinkpixel/marzipan`). Import them directly from `@pinkpixel/marzipan` to remove any external dependency.
|
|
17
|
+
- **Plugins ship in the box** – Every plugin in `src/plugins` is published under `@pinkpixel/marzipan/plugins/<name>`. Each guide explains how to tree-shake just the features you need.
|
|
18
|
+
- **Docs mirror the repo** – Content in `/docs` matches the current repository layout (as of October 4, 2025). When files move, update both the guide and [docs/TABLE_OF_CONTENTS.md](./TABLE_OF_CONTENTS.md).
|
|
19
|
+
|
|
20
|
+
## 🔖 Recommended Reading Order
|
|
21
|
+
|
|
22
|
+
1. **Quick Start** – get an editor running in under five minutes.
|
|
23
|
+
2. **API Reference** – understand the Marzipan class, events, and helper utilities.
|
|
24
|
+
3. **Plugin Catalogue** – explore optional capabilities like tables, Mermaid, media helpers, and syntax highlight.
|
|
25
|
+
4. **Type Definitions** – browse generated typings for IDE integration.
|
|
26
|
+
|
|
27
|
+
## 🧁 Related Resources
|
|
28
|
+
|
|
29
|
+
- Project overview and roadmap: [../OVERVIEW.md](../OVERVIEW.md)
|
|
30
|
+
- Repository changelog: [../CHANGELOG.md](../CHANGELOG.md)
|
|
31
|
+
- Demo playground guide: [../bakeshop-demo/README.md](../bakeshop-demo/README.md)
|
|
32
|
+
|
|
33
|
+
Have feedback? Open an issue or PR – documentation updates are always welcome.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# 📑 Documentation Table of Contents
|
|
2
|
+
|
|
3
|
+
## Getting Started
|
|
4
|
+
- [Documentation Portal](./README.md)
|
|
5
|
+
- [Quick Start](./quick-start.md)
|
|
6
|
+
|
|
7
|
+
## Core Reference
|
|
8
|
+
- [API Reference](./api.md)
|
|
9
|
+
- [Type Definitions](./types.d.ts)
|
|
10
|
+
|
|
11
|
+
## Extensions
|
|
12
|
+
- [Plugin Catalogue](./plugins.md)
|
|
13
|
+
|
|
14
|
+
## Related Root Docs
|
|
15
|
+
- [Project Overview](../OVERVIEW.md)
|
|
16
|
+
- [Changelog](../CHANGELOG.md)
|
|
17
|
+
- [Bakeshop Demo Guide](../bakeshop-demo/README.md)
|
|
18
|
+
|
|
19
|
+
Need something else? Open an issue or PR – contributions to the docs are welcome!
|