# remark-serve

> display remark slides inside a directory

Latest version **1.0.2** (published 2019-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install remark-serve
pnpm add remark-serve
yarn add remark-serve
bun add remark-serve
```

Provides the command `remark-serve`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-05-30 |
| First published | 2017-10-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vincent Billey |
| Maintainers | fenntasy |

## Links

- npm: https://www.npmjs.com/package/remark-serve
- Repository: https://github.com/Fenntasy/remark-serve
- Issues: https://github.com/Fenntasy/remark-serve/issues
- npm.io page: https://npm.io/package/remark-serve

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^7.1.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [express](https://npm.io/package/express.md) ^4.17.1
- [node-sass](https://npm.io/package/node-sass.md) ^4.12.0
- [read-yaml](https://npm.io/package/read-yaml.md) ^1.1.0
- [node-sass-tilde-importer](https://npm.io/package/node-sass-tilde-importer.md) ^1.0.2

## Recent versions

- 1.0.2 (latest) — 2019-05-30
- 1.0.1 — 2018-03-27
- 1.0.0 — 2018-03-09
- 0.1.0 — 2017-11-19
- 0.0.2 — 2017-10-23
- 0.0.1 — 2017-10-23

## README

# Remark-serve

## Usage

Go into a directory with one or more remark `.md` files and launch `remark-serve`.

Each slides will have a URL.

## Installation

`npm install -g remark-serve`

## Options

You can have a YML file at the root of the repository where you want to use `remark-serve` with the following options.

`pattern: (string)` a glob pattern if you want to serve slides in recursively (ig: `"**/*.md"`).

`assets: (object)` a key-value object where keys are the route URL for the asset directory and values are the associated paths.

`css_files`: (array) list of CSS files that will be includes in the final HTML.
Can be either HTTP URLs or a local file.
A local file could be a SASS file.

`css`: (string) direct CSS that will be included

`remarkOptions`: (string) JavaScript options passed to the `remark.create(options)` call.
This must be a string to work.

Example:

```yaml
pattern: "**/*.md"
assets:
  "/images": "../assets/images/"
css_files:
  - https://fonts.googleapis.com/css?family=Open+Sans|Roboto:400,900
  - https://fonts.googleapis.com/css?family=Source+Code+Pro
css: >
  blockquote {
    color: green;
  }
remarkOptions: >
  {
    ratio: "16:9",
    highlightLanguage: "javascript",
    highlightStyle: "tomorrow",
    navigation: {
      scroll: false
    },
    slideNumberFormat: "%current%"
  }
```

---
_Source: https://npm.io/package/remark-serve · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._