Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/userGuide/cliCommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Options:

Setup Commands
init|i [options] [root] init a markbind site
skills Manage AI coding skills for this project

Site Commands
serve|s [options] [root] Build then serve a website from a directory
Expand Down Expand Up @@ -73,6 +74,50 @@ Commands:
</div>
<hr><!-- ========================================================================== -->

<div id="markbind-skills">

### `skills` Command
<br>

**Format:** `markbind skills [command] [options]`

**Description:** Manages AI coding skills for the current project.

Use `markbind skills --help` to view all available subcommands.

<panel header="**Subcommands** :fas-cogs:" type="minimal" expanded>

**Subcommands** :fas-cogs:

* `install`<br>
Downloads skills from the MarkBind skills repository and installs them into `.agents/skills`.
During installation, MarkBind prompts you to choose additional agent directories for optional symlinks.

* **Format:** `markbind skills install [options]`
* **Options:**
* `--ref <ref>`: Uses a specific git tag or branch instead of the MarkBind-version-matched ref.
* `--force`: Overwrites existing installed skills.
* **{{ icon_examples }}**
* `markbind skills install` : Installs skills using the default ref for your MarkBind version.
* `markbind skills install --ref v7.0.0` : Installs skills from the `v7.0.0` ref.
* `markbind skills install --force` : Reinstalls skills and overwrites existing installed skills.

* `update`<br>
Re-downloads skills for the current MarkBind version and overwrites the existing installation.

* **Format:** `markbind skills update [options]`
* **Options:**
* `--ref <ref>`: Uses a specific git tag or branch instead of the MarkBind-version-matched ref.
* **{{ icon_examples }}**
* `markbind skills update` : Updates installed skills using the default ref for your MarkBind version.
* `markbind skills update --ref v7.0.0` : Updates installed skills from the `v7.0.0` ref.

</panel>

</div>

<hr><!-- ========================================================================== -->

### `serve` Command
<br>

Expand Down
6 changes: 6 additions & 0 deletions docs/userGuide/gettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,12 @@ You can add the `--help` flag to any command to show the help screen. <br>
<span id="tip_body">
The `init` command populates the project with the [default project template](https://markbind-init-typical.netlify.app/). Refer to [templates](templates.html) section to learn how to use a different template.
</span>
</include>

<include src="tip.md" boilerplate >
<span id="tip_body">
If you use AI coding assistants, you can install project-level skills using `markbind skills install`. See [CLI Commands: `skills`](cliCommands.html#markbind-skills).
</span>
</include>

</tab>
Expand Down
15 changes: 14 additions & 1 deletion docs/userGuide/makingTheSiteSearchable.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,19 @@ You can add a search bar component to your website to allow users to search the
MarkBind now supports [Pagefind](https://pagefind.app/), a static low-bandwidth search library, as a built-in feature. This provides full-text search capabilities without external services.

<box type="info">
This is a <strong>beta</strong> feature and will be refined in future updates. To use it, you must have <code>enableSearch: true</code> in your <code>site.json</code> (this is the default).
This is a <strong>beta</strong> feature and will be refined in future updates. To use it, you explicitly enable it in your <code>site.json</code>. Add the <code>pagefind</code> configuration with <code>enablePagefind: true</code>.

<panel header="Example of `site.json`">

```json
{
"pagefind": {
"enablePagefind": true
}
}
```
</panel>

</box>

<box type="warning">
Expand Down Expand Up @@ -94,6 +106,7 @@ In your `site.json`:
```json
{
"pagefind": {
"enablePagefind": true,
"exclude_selectors": [".algolia-no-index", "[class*='algolia-no-index']"]
}
}
Expand Down
Loading
Loading