Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xudafeng/startserver
Yet another http server just for fun.
https://github.com/xudafeng/startserver
nodejs server static
Last synced: 3 days ago
JSON representation
Yet another http server just for fun.
- Host: GitHub
- URL: https://github.com/xudafeng/startserver
- Owner: xudafeng
- License: mit
- Created: 2014-06-03T04:16:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-21T16:05:43.000Z (8 months ago)
- Last Synced: 2024-12-18T03:08:42.974Z (11 days ago)
- Topics: nodejs, server, static
- Language: JavaScript
- Homepage:
- Size: 197 KB
- Stars: 91
- Watchers: 11
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# startserver
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/startserver.svg?style=flat-square
[npm-url]: https://npmjs.org/package/startserver
[travis-image]: https://img.shields.io/travis/xudafeng/startserver.svg?style=flat-square
[travis-url]: https://travis-ci.org/xudafeng/startserver
[coveralls-image]: https://img.shields.io/coveralls/xudafeng/startserver.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/xudafeng/startserver?branch=master
[node-image]: https://img.shields.io/badge/node.js-%3E=_4-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/startserver.svg?style=flat-square
[download-url]: https://npmjs.org/package/startserver
> Yet another http server.
## Installation
```shell
$ npm i startserver -g
```
## Quick Start
```shell
$ startserver
```
It also can be use it like this:
```shell
$ startserver -p 6789
```
There are more shorter alias for it:
```shell
$ ss
```
## Features
### Server Everywhere
Run it at every directory under the root.
* Automatic detection of unoccupied port.
### Slider Revolution
Generate slider with `README.md` file or other markdown file.
* Suppor a inverse color style.
* Double click for temporary modifications, again to restore.
* Normal to read makedown.
* Highlight for your code block.
* Thumbnail mode provided.
* Watching markdown file.
### Others
* Generator support and compatible runtime.
* Original javascript source code.
## Commands
#### plugins
show plugin list
#### generate
```shell
$ startsever generate README.md
```
generate static slide file to markdown [[sample]](https://rawgit.com/xudafeng/startserver/master/README.md.html)
## Plugins
[plugins list](//github.com/startserver)
## Options
#### -s, --silent
start http server without opening browser
#### -m, --markdown
auto parse and render markdown file
#### -f, --pdf
render markdown file with pdf style
#### -p, --port
port to use (8080 default)
#### -d, --disable
disable default index router
#### -v, --version
output version infomation
## Help
```shell
$ startserver -h
```
## Contributors
|[
xudafeng](https://github.com/xudafeng)
|[
karoo](https://github.com/karoo)
|[
06wj](https://github.com/06wj)
|[
ottomao](https://github.com/ottomao)
|[
helldance](https://github.com/helldance)
|[
zhuyali](https://github.com/zhuyali)
|
| :---: | :---: | :---: | :---: | :---: | :---: |
[
meowtec](https://github.com/meowtec)
This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Jul 05 2021 13:57:01 GMT+0800`.
## License
The MIT License (MIT)
Copyright (c) 2013 xdf