@sfdocs-internal/remark-grid-plugin v1.0.0-alpha

Grid plugin

About

Grid plugin is a remark plugin which uses generic directive syntax to render markdown contents in grid layout.

Grid Plugin Syntax

<!-- Generic Directive Syntax for Grid -->

::::grid{columns=2}

:::grid-item
## Grid Item1
Example text
:::

:::grid-item
## Grid Item2
Example text
:::

:::grid-item
## Grid Item3
Example text
:::

:::grid-item
## Grid Item4
Example text
:::

::::

The above plugin syntax will be converted to LWC dx-grid component as represented below,

<dx-grid columns="2">
   <div>
      <h2>Example Item1</h2>
      <p>Example text</p>
   </div>
   <div>
      <h2>Example Item2</h2>
      <p>Example text</p>
   </div>
   <div>
      <h2>Example Item3</h2>
      <p>Example text</p>
   </div>
   <div>
      <h2>Example Item4</h2>
      <p>Example text</p>
   </div>
</dx-grid>

Install & build

yarn install && yarn build

Pubilsh

yarn publish

Please make sure to merge your changes which includes, version number releases & code changes to git after publishing is done.