Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
giuseppeg committed Sep 17, 2020
1 parent 1619ad7 commit ca9b402
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ xm CLI comes with a **dev mode** that compiles and serves built HTML.

Furthermore xm is built on top of [posthtml-cli](https://posthtml.org/#/cli) and therefore it is [extensible](https://posthtml.org/#/cli?id=options).

Are you using xm? Share your site's URL [here](https://github.com/giuseppeg/xm/issues/2).

## Install

```
Expand Down Expand Up @@ -79,6 +81,14 @@ xm supports importing `.md` (markdown) files too. When importing such files the

💡 This feature can be used to generate styled docs sites for your open source project!

If you create a reusable theme for README-like files we encourage you to use the following naming convention:

```
xm-theme-<theme-name>
```

Share your site or theme URL [here](https://github.com/giuseppeg/xm/issues/2).

#### `<slot>` and `<fill>` elements

HTML files can define `slot` elements with an attribute `name`. slots can be filled when importing HTML files using the `fill` tag.
Expand Down
3 changes: 3 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ <h1 id="₪-xm---extensible-html">₪ xm - extensible HTML</h1>

<p>xm CLI comes with a <strong>dev mode</strong> that compiles and serves built HTML.</p>
<p>Furthermore xm is built on top of <a href="https://posthtml.org/#/cli">posthtml-cli</a> and therefore it is <a href="https://posthtml.org/#/cli?id=options">extensible</a>.</p>
<p>Are you using xm? Share your site&#39;s URL <a href="https://github.com/giuseppeg/xm/issues/2">here</a>.</p>
<h2 id="install">Install</h2>
<pre><code>npm i -g xm</code></pre><h3 id="usage">Usage</h3>
<pre><code>Usage: xm &lt;command&gt; [options]
Expand Down Expand Up @@ -142,6 +143,8 @@ <h2 id="install">Install</h2>
&lt;/style&gt;
&lt;import href=&quot;README.md&quot; /&gt;</code></pre>
<p>💡 This feature can be used to generate styled docs sites for your open source project!</p>
<p>If you create a reusable theme for README-like files we encourage you to use the following naming convention:</p>
<pre><code>xm-theme-&lt;theme-name&gt;</code></pre><p>Share your site or theme URL <a href="https://github.com/giuseppeg/xm/issues/2">here</a>.</p>
<h4 id="slot-and-fill-elements"><code>&lt;slot&gt;</code> and <code>&lt;fill&gt;</code> elements</h4>
<p>HTML files can define <code>slot</code> elements with an attribute <code>name</code>. slots can be filled when importing HTML files using the <code>fill</code> tag.</p>
<pre><code class="language-html">&lt;!-- base.html --&gt;
Expand Down

0 comments on commit ca9b402

Please sign in to comment.