@centricle/rtfm 1.0.3 → 1.1.1

package/bin/rtfm.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+const fs = require('fs');
+const path = require('path');
 const { serve } = require('../lib/serve');
 const { init } = require('../lib/init');
 const { sidebar } = require('../lib/sidebar');
@@ -49,6 +51,7 @@ rtfm - Local docs reader. Zero dependencies. Zero network.
 
 Usage:
   rtfm                  Serve current directory, open browser
+  rtfm [file.md]        Serve a single markdown file
   rtfm serve [dir]      Serve specified directory
   rtfm init             Scaffold rtfm files into current directory
   rtfm sidebar          Auto-generate _sidebar.md from *.md files
@@ -80,7 +83,15 @@ switch (cmd) {
   case 'open':
     open(positional[1] || '/', flags);
     break;
-  default:
-    // Assume it's a directory to serve
-    serve(cmd, flags);
+  default: {
+    // Single .md file: serve its directory, open to that file
+    const resolved = path.resolve(cmd);
+    if (cmd.endsWith('.md') && fs.existsSync(resolved) && fs.statSync(resolved).isFile()) {
+      const dir = path.dirname(resolved);
+      const docPath = path.basename(resolved, '.md');
+      serve(dir, flags, docPath);
+    } else {
+      serve(cmd, flags);
+    }
+  }
 }

package/lib/serve.js

@@ -22,7 +22,7 @@ const MIME_TYPES = {
   '.ttf': 'font/ttf'
 };
 
-function serve(dir, flags) {
+function serve(dir, flags, openPath) {
   const root = path.resolve(dir);
 
   // If not initialized, auto-init + generate sidebar
@@ -89,7 +89,8 @@ function serve(dir, flags) {
       console.log('Press Ctrl+C to stop');
 
       if (flags.open) {
-        openBrowser(url);
+        const target = openPath ? `${url}/#/${openPath}` : url;
+        openBrowser(target);
       }
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centricle/rtfm",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "description": "Local docs reader. Zero dependencies. Zero network.",
   "bin": {
     "rtfm": "bin/rtfm.js"

package/templates/index.html

@@ -184,7 +184,21 @@
       loadSidebar: true,
       subMaxLevel: 2,
       auto2top: true,
-      routerMode: 'history'
+      routerMode: 'hash',
+      plugins: [
+        function(hook) {
+          hook.doneEach(function() {
+            var path = window.location.hash.replace(/^#\/?/, '');
+            if (path) {
+              // Use filename from route as tab title
+              var name = path.split('/').pop().replace(/\.md$/i, '');
+              document.title = decodeURIComponent(name);
+            } else {
+              document.title = 'rtfm';
+            }
+          });
+        }
+      ]
     }
   </script>
   <script src="/docsify.min.js"></script>