pub-server
markdown site generator, web server, and editor
Last updated 4 months ago by jldec .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install pub-server -g
SYNC missed versions from official npm registry.

pub-server

Azure Build Status Build Status

Docs

pub-server, or pub for short is an HTML site-generator and editor entirely written in JavaScript.

The following use-cases are supported

  • Command-line tool for generating static websites
  • Web server for previewing generated HTML locally
  • Web server deployed on a PaaS like Heroku

For users with node.js, pub-server provides a simple command-line utility which can render an HTML website from markdown in any directory. The generated output uses npm-installable themes and is fully customizable.

The generator+editor can also run in-browser, allowing non-technical users to edit and instantly preview the generated HTML, without first installing pub-server themselves.

To see this in action, check out the docs at https://jldec.github.io/pub-doc/. The editor appears when you click on the edit button at the top right. Feel free to play around - in this instance, your changes will not be recorded.

Other examples include a presentation theme, a flexbox design, and a blog

installation

pub-server requires node.js v6 or later running on MacOS or Linux.

npm install -g pub-server

usage

  • pub (with no options) serves *.md in the current directory or looks for a pub-config.js. The default theme is useful for previewing GitHub README.md files like this one. The server will watch for changes and update http://localhost:3001/ whenever markdown files or CSS or other static files are saved.

  • pub -O generates .html and other static files (including generator + editor) to ./out.

  • pub -S <dir> serves static files from any directory. It will mimic the behavior of GitHub Pages, looking for index.html files in folders, and redirecting from /folder-name to /folder-name/

  • pub -h shows the usage info below:

pub-server v2.0.2

usage: pub [opts] [dir]
opts:
  -p, --port <port>        server port [3001]
  -t, --theme <name>       theme module-name or dir, repeatable (default: [])
  -o, --output-path <dir>  output dir [./out]
  -O, --output-only        output html, scripts, static files and exit
  -r, --root <prefix>      generate /prefix urls, "." means path relative
  -s, --static <dir>       static dir, repeatable, supports <dir>,<route> (default: [])
  -S, --static-only <dir>  serve only static files from <dir> (default: [])
  -C, --config             show config and exit
  -I, --ignore-config      ignore pub-config file
  -P, --pages              show pages and templates and exit
  -w, --watch-pkgs         also watch inside packages
  -W, --no-watch           disable watcher entirely
  -K, --no-sockets         no websockets
  -E, --no-editor          website only, no editor support
  -m, --minify             minify scripts
  -d, --dbg                enable scriptmaps and client-side debug traces
  -D, --debug              node --debug (server and client-side)
  -B, --debug-brk          node --debug-brk (server and client-side)
  -h, --help               output usage information

credits

Major dependencies include:

npm ls will list them all.

Current Tags

  • 2.0.2                                ...           latest (4 months ago)

79 Versions

  • 2.0.2                                ...           4 months ago
  • 2.0.1                                ...           6 months ago
  • 2.0.0                                ...           6 months ago
  • 1.10.2                                ...           4 years ago
  • 1.10.1                                ...           4 years ago
  • 1.10.0                                ...           4 years ago
  • 1.9.21                                ...           4 years ago
  • 1.9.20                                ...           4 years ago
  • 1.9.19                                ...           4 years ago
  • 1.9.18                                ...           4 years ago
  • 1.9.17                                ...           4 years ago
  • 1.9.16                                ...           4 years ago
  • 1.9.15                                ...           4 years ago
  • 1.9.14                                ...           4 years ago
  • 1.9.13                                ...           4 years ago
  • 1.9.12                                ...           4 years ago
  • 1.9.11                                ...           4 years ago
  • 1.9.10                                ...           4 years ago
  • 1.9.9                                ...           4 years ago
  • 1.9.8                                ...           4 years ago
  • 1.9.7                                ...           4 years ago
  • 1.9.6                                ...           4 years ago
  • 1.9.5                                ...           4 years ago
  • 1.9.4                                ...           4 years ago
  • 1.9.3                                ...           4 years ago
  • 1.9.2                                ...           4 years ago
  • 1.9.1                                ...           4 years ago
  • 1.9.0                                ...           4 years ago
  • 1.8.7                                ...           4 years ago
  • 1.8.6                                ...           4 years ago
  • 1.8.5                                ...           4 years ago
  • 1.8.4                                ...           4 years ago
  • 1.8.3                                ...           4 years ago
  • 1.8.2                                ...           4 years ago
  • 1.8.1                                ...           4 years ago
  • 1.8.0                                ...           4 years ago
  • 1.7.23                                ...           4 years ago
  • 1.7.22                                ...           4 years ago
  • 1.7.21                                ...           4 years ago
  • 1.7.20                                ...           4 years ago
  • 1.7.19                                ...           4 years ago
  • 1.7.18                                ...           4 years ago
  • 1.7.17                                ...           4 years ago
  • 1.7.15                                ...           4 years ago
  • 1.7.14                                ...           4 years ago
  • 1.7.13                                ...           4 years ago
  • 1.7.12                                ...           4 years ago
  • 1.7.11                                ...           4 years ago
  • 1.7.10                                ...           4 years ago
  • 1.7.9                                ...           4 years ago
  • 1.7.8                                ...           4 years ago
  • 1.7.7                                ...           4 years ago
  • 1.7.6                                ...           4 years ago
  • 1.7.5                                ...           4 years ago
  • 1.7.4                                ...           4 years ago
  • 1.7.3                                ...           4 years ago
  • 1.7.2                                ...           4 years ago
  • 1.7.1                                ...           4 years ago
  • 1.7.0                                ...           4 years ago
  • 1.6.0                                ...           4 years ago
  • 1.5.1                                ...           4 years ago
  • 1.5.0                                ...           4 years ago
  • 1.4.3                                ...           4 years ago
  • 1.4.2                                ...           4 years ago
  • 1.4.1                                ...           4 years ago
  • 1.4.0                                ...           4 years ago
  • 1.3.2                                ...           5 years ago
  • 1.3.1                                ...           5 years ago
  • 1.3.0                                ...           5 years ago
  • 1.2.1                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.6                                ...           5 years ago
  • 1.0.5                                ...           5 years ago
  • 1.0.4                                ...           5 years ago
  • 1.0.3                                ...           5 years ago
  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 18
Dependencies (33)
Dev Dependencies (2)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |