-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforge-markdown.html
More file actions
706 lines (684 loc) · 35.3 KB
/
Copy pathforge-markdown.html
File metadata and controls
706 lines (684 loc) · 35.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
<!doctype html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Forge Kernel - ForgeMarkDown</title>
<script src="https://cdn.tailwindcss.com"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css"
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css"
rel="stylesheet"
/>
<link rel="stylesheet" href="assets/css/docs.css" />
</head>
<body class="bg-gray-50 text-gray-900">
<!-- Navigation -->
<nav class="bg-white shadow-sm border-b">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex items-center">
<div class="flex-shrink-0">
<h1 class="text-xl font-bold text-gray-900">
Forge Kernel
</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a
href="index.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Home
</a>
<a
href="getting-started.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Getting Started
</a>
<a
href="core-concepts.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Core Concepts
</a>
<a
href="capabilities.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Capabilities
</a>
<a
href="api-reference.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
API Reference
</a>
<a
href="tutorial.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600"
>
Tutorials
</a>
</div>
</div>
<div class="flex items-center sm:hidden">
<button
id="mobile-menu-button"
class="text-gray-700 hover:text-blue-600 p-2"
>
<i class="fas fa-bars text-xl"></i>
</button>
</div>
</div>
</div>
<div
id="mobile-menu"
class="sm:hidden hidden bg-white border-t border-gray-200"
>
<div class="px-2 pt-2 pb-3 space-y-1">
<a
href="index.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Home</a
>
<a
href="getting-started.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Getting Started</a
>
<a
href="core-concepts.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Core Concepts</a
>
<a
href="capabilities.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Capabilities</a
>
<a
href="api-reference.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>API Reference</a
>
<a
href="tutorial.html"
class="block px-3 py-2 text-gray-900 hover:text-blue-600"
>Tutorials</a
>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<div class="flex flex-col lg:flex-row gap-8">
<!-- Sidebar Navigation -->
<div id="sidebar-nav" class="lg:w-1/4">
<div class="bg-white rounded-lg shadow-sm p-6 sticky top-8">
<h3 class="text-lg font-semibold text-gray-900 mb-4">
ForgeMarkDown
</h3>
<nav class="space-y-2">
<a
href="#overview"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Overview</a
>
<a
href="#how-it-works"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>How It Works</a
>
<a
href="#inline-syntax"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Inline Syntax</a
>
<a
href="#block-syntax"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Block Syntax</a
>
<a
href="#code-blocks"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Code Blocks</a
>
<a
href="#front-matter"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Front Matter</a
>
<a
href="#from-your-code"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>From Your Code</a
>
<a
href="#what-it-isnt"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>What It Isn't</a
>
<a
href="#installation"
class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600"
>Installation</a
>
</nav>
<div class="mt-6 pt-6 border-t border-gray-200">
<h4 class="font-semibold text-sm mb-3 text-blue-600">
Related
</h4>
<nav class="space-y-2">
<a
href="forge-templates.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeTemplates — compose HTML content →</a
>
<a
href="forge-notification.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeNotification — multi-channel messages →</a
>
<a
href="forge-hub.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>ForgeHub — administration hub →</a
>
<a
href="capabilities.html"
class="block text-gray-600 hover:text-blue-600 py-1 text-sm"
>All capabilities →</a
>
</nav>
</div>
</div>
</div>
<!-- Main Content -->
<div class="lg:w-3/4">
<div class="bg-white rounded-lg shadow-sm p-8">
<h1 class="text-4xl font-bold text-gray-900 mb-6">
ForgeMarkDown
</h1>
<p class="text-xl text-gray-600 mb-4">
A small markdown processor that <strong>your app</strong>
can call to turn Markdown text into HTML. It's a
single-purpose converter with a deliberately small
feature set — everything it recognizes maps directly
to semantic HTML, and nothing more. No framework, no
build pipe, no opinions about your markup.
</p>
<!-- Overview -->
<section id="overview" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Overview
</h2>
<p class="text-gray-600 mb-4">
ForgeMarkDown is exposed to your app as the
<code>ForgeMarkDownInterface</code>, resolved
through the container — you ask for it and call
<code>parse()</code>:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Modules\ForgeMarkDown\Contracts\ForgeMarkDownInterface;
final class SomeController
{
public function __construct(
private readonly ForgeMarkDownInterface $markdown,
) {}
public function show(): string
{
$html = $this->markdown->parse('# Hello, world');
// returns "<h1>Hello, world</h1>"
return $html;
}
}</code></pre>
</div>
<div
class="bg-blue-50 border border-blue-200 rounded-lg p-6"
>
<h3 class="font-semibold text-lg mb-4">
Where you'd reach for it
</h3>
<div
class="grid md:grid-cols-2 gap-4 text-sm text-gray-700"
>
<ul
class="space-y-2 list-disc list-inside"
>
<li>Rendering documentation or help text</li>
<li>Composing formatted email or message bodies</li>
</ul>
<ul
class="space-y-2 list-disc list-inside"
>
<li>Turning user-written notes into safe HTML</li>
<li>Static site / generated content pipelines</li>
</ul>
</div>
</div>
</section>
<!-- How It Works -->
<section
id="how-it-works"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
How It Works
</h2>
<p class="text-gray-600 mb-4">
<code>parse()</code> runs the text through a
single pipeline, in order:
</p>
<ol
class="space-y-2 list-decimal list-inside text-gray-700 mb-4"
>
<li>
<strong>Front matter</strong> — a leading
<code>---</code> YAML block is detected and
stripped.
</li>
<li>
<strong>Block elements</strong> — headings,
horizontal rules, blockquotes, lists, tables,
and code blocks are turned into their HTML.
</li>
<li>
<strong>Inline elements</strong> — emphasis,
strong, strikethrough, links, images, and
inline code inside the remaining text.
</li>
</ol>
<p class="text-gray-600">
The output is trimmed before it's returned, and
anything the processor doesn't recognize passes
through untouched — so the rendered HTML holds only
the structure you asked for.
</p>
</section>
<!-- Inline Syntax -->
<section
id="inline-syntax"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Inline Syntax
</h2>
<p class="text-gray-600 mb-4">
The inline pass recognizes a focused set of
constructs:
</p>
<div class="overflow-x-auto mb-6">
<table
class="w-full text-sm text-left text-gray-700 bg-gray-50 border border-gray-200 rounded-lg"
>
<thead class="bg-gray-200">
<tr>
<th class="px-4 py-2">Markdown</th>
<th class="px-4 py-2">Renders</th>
</tr>
</thead>
<tbody
class="divide-y divide-gray-200"
>
<tr>
<td class="px-4 py-2"><code>**bold**</code> / <code>__bold__</code></td>
<td class="px-4 py-2"><code><strong></code></td>
</tr>
<tr>
<td class="px-4 py-2"><code>*em*</code> / <code>_em_</code></td>
<td class="px-4 py-2"><code><em></code></td>
</tr>
<tr>
<td class="px-4 py-2"><code>~~strike~~</code></td>
<td class="px-4 py-2"><code><del></code></td>
</tr>
<tr>
<td class="px-4 py-2"><code>[text](url)</code></td>
<td class="px-4 py-2"><code><a href></code></td>
</tr>
<tr>
<td class="px-4 py-2"><code></code></td>
<td class="px-4 py-2"><code><img></code></td>
</tr>
<tr>
<td class="px-4 py-2"><code>`code`</code></td>
<td class="px-4 py-2"><code><code></code></td>
</tr>
</tbody>
</table>
</div>
<p class="text-gray-600">
Link and image destinations and inline code are
escaped, so a URL or snippet can't smuggle raw
markup out of your rendered content.
</p>
</section>
<!-- Block Syntax -->
<section
id="block-syntax"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Block Syntax
</h2>
<div
class="grid md:grid-cols-2 gap-4 text-sm text-gray-700 mb-6"
>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">Headings</h3>
<p>
<code>#</code> through <code>######</code>
produce <code><h1></code> to
<code><h6></code>.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">
Horizontal rules
</h3>
<p>
Three or more <code>---</code>,
<code>***</code>, or <code>___</code>
become <code><hr></code>.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">
Blockquotes
</h3>
<p>
A line starting with <code>></code>
becomes a
<code><blockquote></code>.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">Lists</h3>
<p>
Lines starting with <code>-</code>,
<code>*</code>, or <code>+</code> become
a <code><ul></code> with
<code><li></code> items.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">Tables</h3>
<p>
GitHub-style pipe tables
(header + separator +
rows) render to a
<code><table></code> with
<code><thead></code> and
<code><tbody></code>.
</p>
</div>
<div
class="bg-gray-50 border border-gray-200 rounded-lg p-5"
>
<h3 class="font-semibold mb-2">
Code blocks
</h3>
<p>
Fenced (<code>```</code>, optionally with
a language) and indented blocks become
<code><pre><code></code>.
</p>
</div>
</div>
<div
class="code-block p-6 text-white rounded-lg"
>
<pre><code class="language-markdown">## The pitch
> One line of context.
1. first
2. second
| Name | Role |
|-------|--------|
| Ada | Admin |
| Grace | Editor |</code></pre>
</div>
</section>
<!-- Code Blocks -->
<section
id="code-blocks"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Code Blocks
</h2>
<p class="text-gray-600 mb-4">
Fenced code blocks carry an optional language,
which is reflected as a class on the
<code><code></code> element (so your syntax
highlighter can hook in):
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-markdown">```php
$greeting = 'hello';
```</code></pre>
</div>
<p class="text-gray-600">
Rendering to <code><pre><code
class="language-php"></code></pre></code>.
Indented code — four leading spaces or a tab — is
also recognized and wrapped in a
<code><pre><code></code> pair. Block
contents are escaped, keeping rendered examples
intact rather than executable.
</p>
</section>
<!-- Front Matter -->
<section
id="front-matter"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Front Matter
</h2>
<p class="text-gray-600 mb-4">
For whole files, <code>parseFile()</code> handles
a leading YAML front-matter block — handy for
content documents that carry metadata alongside
their body:
</p>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-php">use Modules\ForgeMarkDown\Contracts\ForgeMarkDownInterface;
$result = $markdown->parseFile('storage/docs/welcome.md');
$content = $result['content']; // rendered HTML
$front_matter = $result['front_matter']; // associative array from YAML</code></pre>
</div>
<p class="text-gray-600">
The front-matter array is parsed with the
<code>yaml</code> extension when it's available;
if the YAML can't be parsed, the method returns
that as an error entry rather than throwing.
<code>parse()</code> itself strips any front matter
without attempting to parse it — it's only
<code>parseFile()</code> that yields the metadata
as data.
</p>
</section>
<!-- From Your Code -->
<section
id="from-your-code"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
From Your Code
</h2>
<p class="text-gray-600 mb-4">
Resolve the interface and use the two methods:
</p>
<div
class="bg-gray-50 border border-gray-200 rounded-lg mb-6"
>
<ul
class="space-y-4 text-sm text-gray-700 p-6"
>
<li>
<code>parse(string $markdown): string</code>
— convert a Markdown string to an HTML
string.
</li>
<li>
<code>parseFile(string $path): array</code>
— read a file, return
<code>['content' => html,
'front_matter' => array]</code>.
</li>
</ul>
</div>
<p class="text-gray-600">
Everything is injected, so the converter plugs
into controllers, commands, notification bodies,
or a static-site generator without ceremony — ask
for the interface and it's ready.
</p>
</section>
<!-- What It Isn't -->
<section
id="what-it-isnt"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
What It Isn't
</h2>
<p class="text-gray-600 mb-4">
It's worth being honest about the scope, because
ForgeMarkDown is <em>deliberately</em> small and
not a full spec implementation:
</p>
<ul
class="space-y-2 list-disc list-inside text-gray-700 mb-4"
>
<li>
<strong>Not full CommonMark or GFM</strong> —
it covers a practical subset, not every corner
of the Markdown spec.
</li>
<li>
<strong>Single-line blockquotes</strong> —
a quote is one line; multi-line quote blocks
aren't assembled.
</li>
<li>
<strong>No ordered lists</strong> — list
markers produce <code><ul></code>
regardless of the bullet character.
</li>
<li>
<strong>Raw cells</strong> — table headers and
cells pass through as written, so keep content
you trust in tables.
</li>
</ul>
<p class="text-gray-600">
When you need the full Markdown surface area,
align a dedicated parser with your content — but
for rendering trusted, light Markdown this helper
keeps the footprint tiny and predictable.
</p>
</section>
<!-- Installation -->
<section
id="installation"
class="section-anchor mb-12"
>
<h2 class="text-2xl font-bold text-gray-900 mb-4">
Installation
</h2>
<div
class="code-block p-6 text-white rounded-lg mb-6"
>
<pre><code class="language-bash">php forge.php package:install-module --module=ForgeMarkDown</code></pre>
</div>
<p class="text-gray-600">
The capability has no commands, no routes, and no
config to set — it registers the
<code>ForgeMarkDownInterface</code> binding with
the container, and you start parsing. (Optional:
the <code>yaml</code> extension adds front-matter
data parsing for <code>parseFile()</code>.)
</p>
</section>
</div>
</div>
</div>
</div>
<!-- Footer -->
<footer class="bg-gray-900 text-white py-8 mt-16">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 text-center">
<div class="mb-4">
<span class="text-lg font-bold">Forge Kernel</span>
</div>
<p class="text-gray-400">
A toolbox for builders who like to do things their way.
</p>
</div>
</footer>
<script>
document.querySelectorAll('a[href^="#"]').forEach((anchor) => {
anchor.addEventListener("click", function (e) {
e.preventDefault();
const target = document.querySelector(
this.getAttribute("href"),
);
if (target) {
target.scrollIntoView({
behavior: "smooth",
block: "start",
});
}
});
});
const mobileMenuButton =
document.getElementById("mobile-menu-button");
const mobileMenu = document.getElementById("mobile-menu");
if (mobileMenuButton && mobileMenu) {
mobileMenuButton.addEventListener("click", function () {
mobileMenu.classList.toggle("hidden");
});
}
window.addEventListener("scroll", function () {
const sections = document.querySelectorAll(".section-anchor");
const navLinks = document.querySelectorAll(".nav-link");
let current = "";
sections.forEach((section) => {
const sectionTop = section.offsetTop - 100;
if (window.pageYOffset >= sectionTop) {
current = section.getAttribute("id");
}
});
navLinks.forEach((link) => {
link.classList.remove("active");
if (link.getAttribute("href") === "#" + current) {
link.classList.add("active");
}
});
});
</script>
</body>
</html>