markserv 1.17.3 → 1.19.1

package/README.md

@@ -2,7 +2,7 @@
 	<img alt="Markserv Logo" src="https://markserv.github.io/markserv/media/markserv-readme-banner.svg">
 </p>
 
-> :checkered_flag: serve markdown as html (GitHub style), index directories, and live-reload as you edit
+> :checkered_flag: serve markdown as html (GitHub style), index directories, and hot-reload as you edit
 
 [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-FF69B4.svg?style=flat-square&logo=gitter-white&link=https://gitter.im/markserv)](https://gitter.im/markserv)
 [![CHANGELOG](https://img.shields.io/badge/changelog-&nbsp;✔️-orange.svg?style=flat-square)](CHANGELOG.md)
@@ -20,7 +20,7 @@
 - Markdown content rendered as HTML
 - GitHub flavor CSS and Syntax Highlighting
 - [Just in Time Templating](#stopwatch-just-in-time-templating): Markdown, HTML &amp; LESS
-- LiveReload as you edit
+- Hot-reload as you edit (no browser plugin required)
 - Directory indexes
 - MIME Type file support
 
@@ -75,20 +75,37 @@ Start Markserv and open the closest README.md file in the browser:
 $ readme
 ```
 
-## :zap: Live Reload
+## :zap: Hot Reload
 
-To see real-time updates as you save your markdown files, you will need to install the LiveReload plugin for your browser:
+Markserv includes built-in hot-reload via WebSocket. When you save a Markdown file, the page content updates instantly without a full page reload and without any browser plugin.
 
-- [Chrome](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)
-- [Firefox](https://addons.mozilla.org/addon/livereload-web-extension/)
-- [Internet Explorer](https://github.com/dvdotsenko/livereload_ie_extension)
+To disable hot-reload, use `--no-hotreload`:
 
-With the Live Reload plugin installed and turned on, you should see the page reloading as you save your Markdown file.
+```shell
+markserv --no-hotreload README.md
+```
 
 <p align="center">
 	<img alt="Markserv Live Reload" src="media/markserv-live-reload.gif" width="100%">
 </p>
 
+## :art: Themes
+
+Markserv ships with four themes: **dark** (default), **light**, **synthwave**, and **solarized**. You can set the theme from the CLI:
+
+```shell
+# Use light theme
+markserv --light README.md
+
+# Use synthwave theme
+markserv --synthwave README.md
+
+# Or use the --theme flag for any theme
+markserv --theme solarized README.md
+```
+
+You can also toggle between themes in the browser using the theme button in the bottom-right corner. Your choice is saved in `localStorage` and persists across hot-reloads.
+
 ## :link: Markdown Links
 
 You can link to an external Markdown file in the same way that you use GitHub Wiki links. You can use the example code here to see how external links work.
@@ -105,7 +122,13 @@ Example link:
 
 ## :stopwatch: Just in Time Templating
 
-Markserv allows you to include nested content. Templates are fetched and rendered when you request them in your browser. The `maxDepth` of includes is set to `10`.
+Markserv allows you to include nested content using `--templates`. Templates are fetched and rendered when you request them in your browser. The `maxDepth` of includes is set to `10`.
+
+**Note:** Templating is disabled by default. Enable it with `--templates`:
+
+```shell
+markserv --templates README.md
+```
 
 If you would like to look at an example, you can look in the [tests/templates](tests/templates/) directory of this repo.
 
@@ -114,7 +137,7 @@ To see the server output of this templating example:
 ```shell
 $ git clone@github.com/f1lt3r/markserv.git
 $ cd markserv
-$ markserv tests/templates/index.html
+$ markserv --templates tests/templates/index.html
 ```
 
 ### Include Markdown

package/lib/cli-defs.js

@@ -1,33 +1,48 @@
 module.exports = {
 	flags: {
 		port: {
-			type: 'number',
 			alias: 'p',
 			default: '8642'
 		},
 
-		livereloadport: {
-			type: ['number', 'boolean'],
-			alias: 'b',
-			default: 35729
+		hotreload: {
+			alias: 'l',
+			type: 'boolean',
+			default: true
 		},
 
 		address: {
-			type: 'string',
 			alias: 'a',
 			default: 'localhost'
 		},
 
 		silent: {
-			type: 'boolean',
 			alias: 's',
 			default: false
 		},
 
 		verbose: {
-			type: 'boolean',
 			alias: 'v',
 			default: false
+		},
+
+		theme: {
+			default: 'dark'
+		},
+
+		light: {
+			type: 'boolean',
+			default: false
+		},
+
+		synthwave: {
+			type: 'boolean',
+			default: false
+		},
+
+		templates: {
+			type: 'boolean',
+			default: false
 		}
 	}
 }

package/lib/cli-help.txt

@@ -3,9 +3,12 @@ $ markserv <file/dir>
 $ readme (serve closest README.md file)
 
 Options
-	--port, -p,  HTTP port [port] (80)
-	--livereloadport, -l  LiveReload port [port/false] (35729)
+	--port, -p,  HTTP port [port] (8642)
+	--hotreload, -l  Hot-reload via WebSocket (true), disable with --no-hotreload
 	--browser, -b  Launch browser (true)
 	--silent, -i  Silent (false)
 	--address, -a  Serve on ip/address [address] (localhost)
-	--verbose, -v  Verbose output (false)
+	--verbose, -v  Verbose output (false)
+	--light  Use light theme (default: dark)
+	--synthwave  Use synthwave/retro-neon theme (default: dark)
+	--templates  Enable {file:}, {markdown:}, {html:}, {less:} templating (false)

package/lib/cli.js

@@ -14,21 +14,7 @@ const cliDefs = require('./cli-defs')
 const cliOpts = meow(cliHelp, cliDefs)
 
 const validateServerPath = (serverPath, cwd) => {
-	if (serverPath === cwd) {
-		return cwd
-	}
-
-	let validatedPath
-
-	if (serverPath[0]) {
-		validatedPath = path.normalize(path.join(cwd, serverPath))
-	}
-
-	if (serverPath[0] === '/' || serverPath[0] === '.') {
-		validatedPath = path.normalize(path.join(cwd, serverPath))
-	}
-
-	return validatedPath
+	return path.resolve(cwd, serverPath)
 }
 
 const run = opts => {

package/lib/readme.js

@@ -21,7 +21,8 @@ const fileExistsSync = uri => {
 		if (stat.isFile()) {
 			exists = true
 		}
-	} catch (err) {
+	} catch (error) {
+		console.warn(`${uri} does not exist`, error)
 		exists = false
 	}