serve-markdown-it
Advanced tools
Configurable static file server with markdown-it for parsing Markdown.
Configurable static file server with markdown-it for parsing Markdown.
README & DOCS TODO
yarn global add serve-markdown-it
yarn gen-readme // update README.md
yarn docs // update DOCUMENTATION.md
yarn test // lint & mocha
yarn update-deps // bump all deps
See CHANGELOG.md for more information.
Distributed under the MIT license. See LICENSE.md for more information.
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)The standalone JSDoc reference can be found in DOCUMENTATION.md
serve-markdown-it.Description TODO.
Configurable static file server with markdown-it for parsing Markdown.
objectDefault markdown-it plugin configuration.
objectDefault configuration data; any loaded user configuration is applied on top of the default values, using cosmiconfig.
PromiseResolve the runtime configuration, loading the first user config file found. Searches directories up the path for any of the following files:
.sermitrc.sermitrc.js.sermitrc.json.sermitrc.yaml.sermitrc.ymlAny discovered user config file is merged with the default DefaultConfig object.
PromiseStarts an HTTP server on the configured port, and serves static files out of
the specified basePath. If the basePath is a file, only that file will
be rendered, excluding any resolved assets.
Files provided by the configured template are rendered from disk. Any URLs
ending in /raw have the suffix removed and cause any matching file in
basePath to be rendered like an asset. This allows file contents to be
rendered with a link to the file itself.
If a URL is not an asset or raw file, it is checked against the
matchMarkdownFileNames regex on the provided Config object. Files
that match are passed through markdown-it.
Any remaining URLs are assumed to map to the basePath; if they are files,
they are rendered as source within markdown code fences. Directories trigger
the file explorer if allowed by the configuration.
objectPlugin configuration data.
string | PluginConfigPlugin definition, either a raw module name or config object.
objectConfiguration data.
serve-markdown-it.Description TODO.
Configurable static file server with markdown-it for parsing Markdown.
License: MIT
Example (sermit help)
sermit [path] [options]
Serve local files
Commands:
sermit print-config Log the merged configuration to the console
sermit gen-config Generate a new configuration file
sermit render Render local files to static HTML
sermit serve [path] [options] Serve local files [default]
Options:
--log-level, -l Log level, increase to debug
[string] [choices: 'error', 'info', 'warn', 'debug'] [default: 'error']
--path, -p Root directory
[string] [required] [default: '/home/user/code/personal/serve-markdown-it']
--help Show help [boolean]
--version Show version number [boolean]
--port Port number to spawn HTTP server on
[number] [required] [default: 8960]
Examples:
sermit gen-config > .sermitrc.json Generate basic configuration
Example (sermit)
[cli] › ★ star read config from /.sermitrc.json
[cli] › ★ star using template default
[cli] › ★ star using md plugin markdown-it-smartarrows
[cli] › ★ star using md plugin markdown-it-anchor
[cli] › ★ star using md plugin markdown-it-highlightjs
[cli] › ★ star serving content from /home/user/code/personal/serve-markdown-it
[cli] › ★ star listening at http://localhost:8960
Example (sermit gen-config > .sermitrc.json)
{
minify: true,
excludeGitIgnore: true,
template: {
name: 'serve-markdown-it-template-default',
config: {
maxWidth: '960px',
sections: {
contentHeader: true,
settings: true,
debug: true,
content: true,
order: [
'settings',
'content',
'debug'
]
},
explorer: {
icons: true,
columns: [
'name',
'user',
'group',
'mode',
'type',
'size'
],
dataTable: {
searchable: true,
sortable: true,
perPage: 25,
perPageSelect: [
10,
25,
50,
100
],
fixedHeight: false,
layout: {
top: '{select}{search}',
bottom: '{pager}'
}
}
},
headerBar: false,
settingsBar: false,
dataTable: false
}
},
markdownIt: {
typographer: true,
linkify: true,
html: true,
plugins: [
{
name: 'markdown-it-smartarrows',
init: 'after',
config: {
auto: true,
code: true
}
},
{
name: 'markdown-it-anchor',
config: {
permalink: true,
permalinkBefore: true,
permalinkSymbol: '§'
},
init: 'after'
},
{
name: 'markdown-it-highlightjs',
config: {
auto: true,
code: true
},
init: 'after'
}
]
}
}
objectDefault markdown-it plugin configuration.
Kind: global constant
Read only: true
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| 0 | object | markdown-it-highlightjs plugin, used to generate highlighted code blocks with highlightjs. | |
| ['0.name'] | string | "'markdown-it-highlightjs'" | module name. |
| ['0.init'] | string | "'after'" | module init method. |
| '0.config' | object | module config. | |
| ['0.config.auto'] | boolean | true | enables automatic language detection |
| ['0.config.code'] | boolean | true | wraps inner markup in <code>/<code> tags. |
objectDefault configuration data; any loaded user configuration is applied on top of the default values, using cosmiconfig.
Kind: global constant
Read only: true
See: DefaultMDPlugins
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| [minify] | boolean | true | enables HTML minification for the server and when rendering, uses html-minifier. |
| [excludeGitIgnore] | boolean | true | if true, any .gitignore file in the target path is loaded and used to filter directory listings. |
| [matchMarkdownFileNames] | RegExp | /.(md | wiki |
| template | object | template configuration. | |
| [template.name] | string | "'serve-markdown-it-template-default'" | default template; @see serve-markdown-it-template-default |
| template.config | object | configuration options passed to the template on initialisation | |
| markdownIt | object | markdown-it parser configuration options. | |
| [markdownIt.typographer] | boolean | true | enables conversion of quotes beautification (smartquotes). |
| [markdownIt.linkify] | boolean | true | enables automatic conversion of text links to <a> tags. |
| [markdownIt.html] | boolean | true | allows HTML tags in markdown source. |
| [markdownIt.plugins] | Array.<PluginDefinition> | DefaultMDPLugins | array of plugins for markdown-it to be loaded. |
PromiseResolve the runtime configuration, loading the first user config file found. Searches directories up the path for any of the following files:
.sermitrc.sermitrc.js.sermitrc.json.sermitrc.yaml.sermitrc.ymlAny discovered user config file is merged with the default DefaultConfig object.
Kind: global function
Returns: Promise - p - resolves with the final Config object.
| Param | Type | Default | Description |
|---|---|---|---|
| params | object | params. | |
| [params.basePath] | string | "cwd" | path to start searching in. |
| [params.configPath] | string | path to pre-loaded user config file, required if config is provided. | |
| [params.config] | object | user config file if already found, search is skipped if provided. |
Example
const config = await getConfig({ basePath: basePath })
const { state } = config
const { md, configPath, template } = state
if (configPath) {
l.star('read config from %s', colors.bgGreen.black(configPath))
}
if (_isEmpty(command) || command === 'serve' || command === 'render') {
l.star('using template %s', colors.cyan(template.name))
md.pluginNames.forEach((name) => {
l.star('using md plugin %s', colors.yellow(name))
})
}
PromiseStarts an HTTP server on the configured port, and serves static files out of
the specified basePath. If the basePath is a file, only that file will
be rendered, excluding any resolved assets.
Files provided by the configured template are rendered from disk. Any URLs
ending in /raw have the suffix removed and cause any matching file in
basePath to be rendered like an asset. This allows file contents to be
rendered with a link to the file itself.
If a URL is not an asset or raw file, it is checked against the
matchMarkdownFileNames regex on the provided Config object. Files
that match are passed through markdown-it.
Any remaining URLs are assumed to map to the basePath; if they are files,
they are rendered as source within markdown code fences. Directories trigger
the file explorer if allowed by the configuration.
Kind: global function
Returns: Promise - p - resolves to koa instance.
| Param | Type | Description |
|---|---|---|
| params | object | params. |
| params.basePath | string | absolute path to the root content directory. |
| params.config | Config | config data. |
Example
const SERVE_HANDLER = async (argv) => {
const { l, port, config, path } = argv
const server = await createServer({ basePath: path, config })
server.listen(port)
l.star('serving content from %s', colors.underline(path))
l.star(
'%s',
colors.cyan.underline(
`listening at ${colors.bold(`http://localhost:${port}`)}`
)
)
}
objectPlugin configuration data.
Kind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | module name. | |
| [init] | string | "'after'" | controls how the plugin is initialized, if 'after' the config is passed after it to markdown-it. If 'call' the module's default export is called with the config data, and the result passed to markdown-it. |
| [config] | object | config data passed to the plugin on initialisation. |
string | PluginConfigPlugin definition, either a raw module name or config object.
objectConfiguration data.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| [minify] | boolean | enables HTML minification for the server and when rendering, uses html-minifier. |
| [excludeGitIgnore] | boolean | if true, any .gitignore file in the target path is loaded and used to filter directory listings. |
| [matchMarkdownFileNames] | RegExp | regular expression used to detect files with Markdown-formatted content. |
| [template] | object | template configuration. |
| [template.name] | string | template module name. |
| [template.config] | object | configuration options passed to the template on initialisation. |
| [markdownIt] | object | markdown-it parser configuration options. All keys besides plugins are passed to the markdown-it constructor. |
| [markdownIt.plugins] | Array.<PluginDefinition> | array of plugins for markdown-it to be loaded. |
FAQs
Configurable static file server with markdown-it for parsing Markdown.
The npm package serve-markdown-it receives a total of 1 weekly downloads. As such, serve-markdown-it popularity was classified as not popular.
We found that serve-markdown-it demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.