Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imcuttle/github-similar-server
A github similar static server with a markdown renderer.
https://github.com/imcuttle/github-similar-server
github github-like server static
Last synced: 21 days ago
JSON representation
A github similar static server with a markdown renderer.
- Host: GitHub
- URL: https://github.com/imcuttle/github-similar-server
- Owner: imcuttle
- License: mit
- Created: 2018-06-02T05:14:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T20:40:35.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T14:36:32.825Z (28 days ago)
- Topics: github, github-like, server, static
- Language: JavaScript
- Homepage:
- Size: 343 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: License
Awesome Lists containing this project
README
# github-similar-server
[](https://travis-ci.org/imcuttle/github-similar-server)
[](https://codecov.io/github/imcuttle/github-similar-server?branch=master)
[](https://www.npmjs.com/package/github-similar-server)
[](https://www.npmjs.com/package/github-similar-server)
A github similar static server with a markdown renderer.
## Usage
### CLI
```bash
npm i github-similar-server -g
github-similar-server -h
```
### Package
```bash
npm i github-similar-server --save
```
```javascript
const app = require('express')()
const gss = require('github-similar-server')
// Use as middleware
app.use('__', gss())
// Or create an express server
const gssApp = gss({
port: 10000, // required!
basePath: '/' // public path
}).then(app => {
// some code here
})
// gssApp.close(() => { console.log('closed') })
```
## Options
#### `root`
github-similar-server works on which file or folder. (_required_)
- Type: `string`
#### `port`
the service port
- Type: `number`
- Default: `8080`
#### `basePath`
the service's base path
- Type: `string`
- Default: `'/'`
#### `silent`
Do not log anything
- Type: `boolean`
- Default: `false`
#### `enableMarkdown`
Enable markdown render
- Type: `boolean`
- Default: `true`
#### `enableStatic`
Enable static file service
- Type: `boolean`
- Default: `true`
#### `markdownTemplate`
The path of markdown's template
- Type: `string`
- Default: [`./src/template.html`](./src/template.html)
#### `markdownTemplateString`
The string source of markdown's template, It has more higher priority.
- Type: `string`
#### `templateParameters`
Extra parameters of template
- Type: `{}`
#### `cache`
- Type: `string`
- Default: `'max-age=-1'`
#### `baseDir`
`baseDir` is not recommended to be assigned if you don't know what you are doing.
Because it has some troubles in ecstatic. https://github.com/jfhbrook/node-ecstatic/issues/235
- Type: `string`
- Default: `req.baseUrl`
**Rest options extend [ecstatic](https://github.com/jfhbrook/node-ecstatic) options**
## Rule
1. Support gfm and render github style markdown when visit `/README.md` or `/path/to/md.md`.
2. The service would response index.html when contains index.html and README.md via url `/`.
3. It would response raw markdown text when with query string `?raw=true`.
## About markdownTemplate
Use [Lodash.template](https://lodash.com/docs/4.17.10#template) with template data:
* title
* markdownHTML
* filename
## Related
- [remark-preset-gfm](https://github.com/imcuttle/remark-preset-gfm) - Remark preset for gfm (GitHub Favorite Markdown)
## License
MIT