mdshelf 0.9.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,12 @@
1
1
  # mdshelf
2
2
 
3
- A single-binary Rust server that turns folders of Markdown files into browsable sites — with hot reload, frontmatter, MiniJinja layouts, and a bundled mobile-first theme. Mount multiple content trees under their own URL prefixes (e.g. `/docs`, `/notes`, `/blog`).
3
+ Turn any folder of Markdown files into a fast, beautiful, browsable site. Point mdshelf at your OpenClaw, Hermes, GBrain, wikis, notes, docs, etc. — mount each one under its own URL (e.g. `/agent`, `/hermes`, `gbrain`, `/docs`, `/notes`, `/blog`) — and read them anywhere with hot reload, clean typography, and a mobile-first theme out of the box.
4
+
5
+ Pairs beautifully with [Tailscale](https://tailscale.com): one command serves your shelf to every device on your tailnet — phone, iPad, laptop. Sharing with Tailscale is fully private by default: no port forwarding, no public DNS, nothing exposed to the open internet.
6
+
7
+ One command installs it as a native system service (launchd, systemd, or Windows SCM) that runs quietly in the background and survives reboots.
8
+
9
+ Ships as a single static Rust binary with zero runtime dependencies.
4
10
 
5
11
  ## Features
6
12
 
@@ -146,7 +152,7 @@ mount = "/blog"
146
152
  title = "Blog"
147
153
  ```
148
154
 
149
- Each `[[sites]]` block mounts a directory at a URL prefix. Only `.md` files are rendered — other files (images, fonts, etc.) are served as static assets. `mount` must not be `/`. Add as many sites as you like.
155
+ Each `[[sites]]` block mounts a directory at a URL prefix. Only `.md` files are rendered — other files are ignored. `mount` must not be `/`. Add as many sites as you like.
150
156
 
151
157
  See [examples/mdshelf.toml](examples/mdshelf.toml) for a complete example.
152
158
 
@@ -179,11 +185,11 @@ Syntax highlighting CSS is served from `/__mdshelf/syntax.css` (class-based, lig
179
185
  Install and manage a native service (launchd on macOS, systemd on Linux, SCM on Windows):
180
186
 
181
187
  ```bash
182
- mdshelf install
183
- mdshelf start
184
- mdshelf status
185
- mdshelf stop
186
- mdshelf uninstall
188
+ sudo mdshelf install
189
+ sudo mdshelf start
190
+ sudo mdshelf status
191
+ sudo mdshelf stop
192
+ sudo mdshelf uninstall
187
193
  ```
188
194
 
189
195
  `--config` is optional and follows the same default search order as other commands. The resolved absolute path is baked into the service definition at install time, so the service always finds its config regardless of working directory.
@@ -226,7 +232,7 @@ Tailscale provisions a certificate automatically and makes the site available **
226
232
  tailscale serve status # confirm the URL
227
233
  ```
228
234
 
229
- Pair it with `mdshelf install && mdshelf start` (see [System service](#system-service)) so both services survive reboots.
235
+ Pair it with `sudo mdshelf install && sudo mdshelf start` (see [System service](#system-service)) so both services survive reboots.
230
236
 
231
237
  To stop serving:
232
238
 
@@ -23,7 +23,7 @@
23
23
  "hasInstallScript": true,
24
24
  "license": "MIT OR Apache-2.0",
25
25
  "name": "mdshelf",
26
- "version": "0.9.0"
26
+ "version": "0.9.1"
27
27
  },
28
28
  "node_modules/@isaacs/cliui": {
29
29
  "engines": {
@@ -542,5 +542,5 @@
542
542
  }
543
543
  },
544
544
  "requires": true,
545
- "version": "0.9.0"
545
+ "version": "0.9.1"
546
546
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "artifactDownloadUrls": [
3
- "https://github.com/prbski/mdshelf/releases/download/v0.9.0"
3
+ "https://github.com/prbski/mdshelf/releases/download/v0.9.1"
4
4
  ],
5
5
  "author": "Patryk Porebski",
6
6
  "bin": {
@@ -100,7 +100,7 @@
100
100
  "zipExt": ".tar.xz"
101
101
  }
102
102
  },
103
- "version": "0.9.0",
103
+ "version": "0.9.1",
104
104
  "volta": {
105
105
  "node": "18.14.1",
106
106
  "npm": "9.5.0"