Skip to content

Commit ea17c02

Browse files
committed
Update README.md to fix formatting issues
Signed-off-by: Pete Cheslock <[email protected]>
1 parent d4eeb19 commit ea17c02

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

remote-content/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ flowchart TD
7070
7171
B --> B1["`**remote-content/remote-content.js**
7272
🎯 Main entry point - imports all sources`"]
73-
B --> B2["`**remote-sources/&#91;category&#93;/&#91;name&#93;.js**
73+
B --> B2["`**remote-sources/category/name.js**
7474
⚙️ Individual content configurations`"]
7575
B --> B3["`**component-configs.js**
7676
📋 Central repository definitions`"]
@@ -91,13 +91,13 @@ flowchart TD
9191
🛠️ Apply multiple transformation layers`"]
9292
9393
C3 --> C3a["`**MDX Compatibility**
94-
<br> → <br />
95-
Fix unclosed HTML tags
94+
Fix HTML tag formatting
95+
Close unclosed HTML tags
9696
• Escape JSX expressions`"]
9797
9898
C3a --> C3b["`**Link & Image Fixing**
99-
./docs/file.md → github.com/org/repo/blob/main/docs/file.md
100-
./image.png → github.com/org/repo/raw/main/image.png`"]
99+
Convert relative links to GitHub URLs
100+
Convert image paths to GitHub raw URLs`"]
101101
102102
C3b --> C3c["`**Frontmatter Addition**
103103
• title, description, sidebar config
@@ -112,7 +112,7 @@ flowchart TD
112112
113113
D --> D1["`**docs/architecture/**
114114
• architecture.mdx (main repo)
115-
• Components/&#91;name&#93;.md (auto-generated)`"]
115+
• Components/component-name.md (auto-generated)`"]
116116
117117
D --> D2["`**docs/guide/**
118118
• Installation guides
@@ -173,19 +173,19 @@ graph TD
173173
174174
I --> I1["`**Step 1: MDX Fixes**
175175
repo-transforms.js<br/>
176-
• Fix <br> tags → <br /><br/>
176+
• Fix HTML tag formatting<br/>
177177
• Fix unclosed HTML tags<br/>
178178
• Escape JSX expressions`"]
179179
180180
I1 --> I2["`**Step 2: Image Resolution**
181181
repo-transforms.js<br/>
182-
![alt]&#40;./path&#41; → ![alt]&#40;github-raw-url&#41;<br/>
183-
&lt;img src='./path'&gt; → &lt;img src='github-raw-url'&gt;`"]
182+
Markdown images to GitHub raw URLs<br/>
183+
HTML img tags to GitHub raw URLs`"]
184184
185185
I2 --> I3["`**Step 3: Link Resolution**
186186
repo-transforms.js<br/>
187-
[text]&#40;./file.md&#41; → [text]&#40;github-blob-url&#41;<br/>
188-
[label]: ./path → &#91;label&#93;: github-blob-url`"]
187+
Relative links to GitHub blob URLs<br/>
188+
Reference links to GitHub blob URLs`"]
189189
190190
I3 --> I4["`**Step 4: Content Wrapping**
191191
utils.js - createContentWithSource()<br/>
@@ -199,7 +199,7 @@ graph TD
199199
sidebar_label: Inference Scheduler<br/>
200200
sidebar_position: 1<br/>
201201
---<br/><br/>
202-
&#91;TRANSFORMED CONTENT&#93;<br/><br/>
202+
TRANSFORMED CONTENT<br/><br/>
203203
:::info Content Source<br/>
204204
This content is automatically synced...<br/>
205205
:::`"]
@@ -228,7 +228,7 @@ graph TD
228228
graph TB
229229
subgraph DOCUSAURUS["**Docusaurus Integration**"]
230230
DC["`**docusaurus.config.js**
231-
plugins: &#91;...remoteContentPlugins&#93;`"]
231+
plugins: ...remoteContentPlugins`"]
232232
end
233233
234234
subgraph MAIN["**Main Entry Point**"]
@@ -260,7 +260,7 @@ graph TB
260260
subgraph SOURCES["**Content Source Configurations**"]
261261
subgraph ARCH["**Architecture Sources**"]
262262
AM["`**architecture-main.js**
263-
Main repo README architecture.mdx`"]
263+
Main repo README to architecture.mdx`"]
264264
CG["`**components-generator.js**
265265
Auto-generates component docs`"]
266266
end

0 commit comments

Comments
 (0)