@@ -169,121 +169,132 @@ const compiler = new Compiler({
169169
170170 <H2 @ id =" install" >Install</H2 >
171171
172- With your favorite package manager
173-
174- <div data-format =" bash" {{highlighted " npm add repl-sdk" }} ></div >
175- <div data-format =" bash" {{highlighted " pnpm add repl-sdk" }} ></div >
176- (etc)
177-
178- <H2 @ id =" bundled-compilers" >Bundled Compilers</H2 >
179-
180- repl-sdk will not load any compiler out of the box on its, unless a
181- <code >compile</code >
182- request is made for that compiler's registered
183- <code >format</code >
184- (sometimes narrowed by a "<code >flavor</code >").
185-
186- <br /><br />
187- Each
188- <code >format</code >
189- represents a
190- <i >file extension</i >. For some
191- <code >format</code >s, there are multiple
192- <code >flavor</code >s, like for
193- <code >jsx</code >.
172+ <p >
173+ With your favorite package manager
174+
175+ <div data-format =" bash" {{highlighted " npm add repl-sdk" }} ></div >
176+ <div data-format =" bash" {{highlighted " pnpm add repl-sdk" }} ></div >
177+ (etc)
178+
179+ <H2 @ id =" bundled-compilers" >Bundled Compilers</H2 >
180+
181+ repl-sdk will not load any compiler out of the box on its, unless a
182+ <code >compile</code >
183+ request is made for that compiler's registered
184+ <code >format</code >
185+ (sometimes narrowed by a "<code >flavor</code >").
186+
187+ <br /><br />
188+ Each
189+ <code >format</code >
190+ represents a
191+ <i >file extension</i >. For some
192+ <code >format</code >s, there are multiple
193+ <code >flavor</code >s, like for
194+ <code >jsx</code >.
195+ </p >
194196
195197 {{#each formats as | formatDocs | }}
196198 <formatDocs />
197199 {{/each }}
198200
199201 <H2 @ id =" api-overview" >API Overview</H2 >
200202
201- There is only available module, and two exports from that module
203+ <p >
204+ There is only available module, and two exports from that module
202205
203- <div data-format =" js" {{highlighted " import {
206+ <div data-format =" js" {{highlighted " import {
204207 Compiler,
205208 defaults
206209} from 'repl-sdk';" }} ></div >
210+ </p >
207211
208212 <H3 class =" code-link" @ id =" index-Compiler" ><code >Compiler</code >
209213 from repl-sdk</H3 >
214+ <p >
210215
211- By default, no configuration is needed.
216+ By default, no configuration is needed.
212217
213- <div data-format =" js" {{highlighted samples.Compiler.basic }} ></div >
218+ <div data-format =" js" {{highlighted samples.Compiler.basic }} ></div >
214219
215- Debug logging can be configured on or conditionally on via any means you choose. Here we can
216- configure logging when
217- <code >debug</code >
218- is present in the query params. This is
219- <em >very</em >
220- noisy for some module graphs, but is helpful in debugging the internal of
221- <code >repl-sdk</code >.
220+ Debug logging can be configured on or conditionally on via any means you choose. Here we can
221+ configure logging when
222+ <code >debug</code >
223+ is present in the query params. This is
224+ <em >very</em >
225+ noisy for some module graphs, but is helpful in debugging the internal of
226+ <code >repl-sdk</code >.
222227
223- <div data-format =" js" {{highlighted samples.Compiler.debug }} ></div >
228+ <div data-format =" js" {{highlighted samples.Compiler.debug }} ></div >
224229
225- If you want to wire up the higher-level messaging from each compiler to your UI, there is this
226- <code >on.log</code >
227- function that can be configured to push log messages outside of the
228- <code >Compiler</code >
230+ If you want to wire up the higher-level messaging from each compiler to your UI, there is this
231+ <code >on.log</code >
232+ function that can be configured to push log messages outside of the
233+ <code >Compiler</code >
229234
230- <div data-format =" js" {{highlighted samples.Compiler.onlog }} ></div >
235+ <div data-format =" js" {{highlighted samples.Compiler.onlog }} ></div >
231236
232- The
233- <code >Compiler</code >
234- can take an options object for configuring each of the compilers. They each may take a different
235- configuration, and will ignore any options that are not expected.
237+ The
238+ <code >Compiler</code >
239+ can take an options object for configuring each of the compilers. They each may take a
240+ different configuration, and will ignore any options that are not expected.
236241
237- <div data-format =" js" {{highlighted samples.Compiler.options }} ></div >
242+ <div data-format =" js" {{highlighted samples.Compiler.options }} ></div >
243+ </p >
238244
239245 <H4 class =" code-link" @ id =" index-Compiler-compile" ><code >< Compiler#compile> </code ></H4 >
240-
241- Calling compile takes 2 to 3 arguments, the file format, the file to compile, and then an
242- optional set of options. The options are optional for all file formats except when there is some
243- ambiguity -- such as for the
244- <code >jsx</code >
245- and
246- <code >hbs</code >
247- file formats.
248-
249- <br /><br />
250- The element doesn't need to be immediately attached anywhere, but in order for the user to view
251- what was compiled, it will need to be placed somewhere.
252-
253- <div data-format =" js" {{highlighted samples.compile.basic }} ></div >
246+ <p >
247+ Calling compile takes 2 to 3 arguments, the file format, the file to compile, and then an
248+ optional set of options. The options are optional for all file formats except when there is
249+ some ambiguity -- such as for the
250+ <code >jsx</code >
251+ and
252+ <code >hbs</code >
253+ file formats.
254+
255+ <br /><br />
256+ The element doesn't need to be immediately attached anywhere, but in order for the user to
257+ view what was compiled, it will need to be placed somewhere.
258+
259+ <div data-format =" js" {{highlighted samples.compile.basic }} ></div >
260+ </p >
254261
255262 <H4 class =" code-link" @ id =" index-Compiler-createEditor" ><code
256263 >< Compiler#createEditor> </code ></H4 >
264+ <p >
257265
258- This editor uses
259- <ExternalLink href =" https://codemirror.net/" >codemirror</ExternalLink >
260- which supports editing on both mobile and desktop devices, as well as proper keyboard
261- accessibility.
262- <br /><br />
263- It has all extensions and syntax configured for each of the supported language formats.
266+ This editor uses
267+ <ExternalLink href =" https://codemirror.net/" >codemirror</ExternalLink >
268+ which supports editing on both mobile and desktop devices, as well as proper keyboard
269+ accessibility.
270+ <br /><br />
271+ It has all extensions and syntax configured for each of the supported language formats.
264272
265- <br /><br />
266- This is
267- <code >await import</code >'d, so if you don't want to use codemirror, you will not pay for the
268- bytes of codemirror in your bundled project.
273+ <br /><br />
274+ This is
275+ <code >await import</code >'d, so if you don't want to use codemirror, you will not pay for the
276+ bytes of codemirror in your bundled project.
269277
270- <div data-format =" js" {{highlighted samples.createEditor.basic }} ></div >
278+ <div data-format =" js" {{highlighted samples.createEditor.basic }} ></div >
279+ </p >
271280
272281 <H3 class =" code-link" @ id =" index-defaults" ><code >defaults</code >
273282 from repl-sdk</H3 >
283+ <p >
274284
275- This is the default configuration for the
276- <code >Compiler</code >. It provides only the
277- <code >formats</code >
278- configuration with all the default compilers.
285+ This is the default configuration for the
286+ <code >Compiler</code >. It provides only the
287+ <code >formats</code >
288+ configuration with all the default compilers.
279289
280- <br /><br />This can be used to add custom compilers, remove existing compilers, or replace them
281- entirely.
290+ <br /><br />This can be used to add custom compilers, remove existing compilers, or replace
291+ them entirely.
282292
283- <div data-format =" js" {{highlighted samples.defaults.basic }} ></div >
293+ <div data-format =" js" {{highlighted samples.defaults.basic }} ></div >
284294
285- Each compiler is
286- <code >await import</code >'d so omitting compilers from this options object will omit their code
287- from your final bundles.
295+ Each compiler is
296+ <code >await import</code >'d so omitting compilers from this options object will omit their
297+ code from your final bundles.
298+ </p >
288299 </div >
289300</template >
0 commit comments