{"id":15634189,"url":"https://github.com/kt3k/remarker","last_synced_at":"2025-04-06T20:09:54.988Z","repository":{"id":22936516,"uuid":"97710128","full_name":"kt3k/remarker","owner":"kt3k","description":":arrow_forward: Remark cli","archived":false,"fork":false,"pushed_at":"2024-07-13T06:25:43.000Z","size":1222,"stargazers_count":142,"open_issues_count":4,"forks_count":27,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-30T19:07:00.258Z","etag":null,"topics":["cli","markdown","presentation","remark","slides","static-site-generator"],"latest_commit_sha":null,"homepage":"https://npm.im/remarker","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kt3k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-19T11:46:22.000Z","updated_at":"2024-08-20T02:05:14.000Z","dependencies_parsed_at":"2023-01-13T22:28:51.395Z","dependency_job_id":"7cf6feab-4915-42b9-a760-5c50db38190f","html_url":"https://github.com/kt3k/remarker","commit_stats":{"total_commits":153,"total_committers":9,"mean_commits":17.0,"dds":0.3137254901960784,"last_synced_commit":"5d0678a5ffe3f3c49ce6b2f2c4eebdc9a9286b93"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fremarker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fremarker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fremarker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fremarker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kt3k","download_url":"https://codeload.github.com/kt3k/remarker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247436254,"owners_count":20938533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","markdown","presentation","remark","slides","static-site-generator"],"created_at":"2024-10-03T10:52:10.020Z","updated_at":"2025-04-06T20:09:54.951Z","avatar_url":"https://github.com/kt3k.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remarker v1.15.0\n\n[![ci](https://github.com/kt3k/remarker/actions/workflows/ci.yml/badge.svg)](https://github.com/kt3k/remarker/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/kt3k/remarker/branch/master/graph/badge.svg)](https://codecov.io/gh/kt3k/remarker)\n\n\u003e [Remark][remark] cli\n\n[remark][remark] is a simple, in-browser, markdown-driven slideshow tool.\n`remarker` is a command line tool for building a remark-based slideshow page\nvery easily.\n\n# Usage\n\nInstall via npm:\n\n```console\n$ npm install --save remarker\n```\n\nWrite your slide in markdown:\n\n```md\n# My Slide\n\n---\n\n# My Slide 2\n\n???\n\nPresenter notes here\n\n---\n```\n\nsave the above as `slides.md`\n\nInvoke `remarker` command.\n\n```console\n$ ./node_modules/.bin/remarker\n```\n\nOr if you have `npx` command, then hit:\n\n```console\n$ npx remarker\n```\n\nThis starts a local server at port 6275 (this is configurable) and you can see\nyour slides at [http://localhost:6275/](http://localhost:6275/).\n\nSee remark's [slide](https://remarkjs.com/) and\n[documentation](https://github.com/gnab/remark#remark) for more details about\nits syntax, features etc.\n\n## Build slides\n\nYou can build your slides as static page as `remarker build` command.\n\n```console\n$ ./node_modules/.bin/remarker build\n```\n\nThis builds your slides as html page under `build/` directory. The output\ndirectory is configurable. See the below for details.\n\n## Installing globally\n\nYou can instead install it globally, in one of these two ways:\n\n```bash\nsudo npm i -g remarker    # from the npm repository\nsudo npm i -g .           # if there's a clone in the current directory\n```\n\nAfter that, you should be able to invoke it this way from any directory in your\nsystem:\n\n```bash\nremarker [build]\n```\n\n# Configuration\n\nYou can configure remarker with the configuration file `remarker.yml`:\n\n(Note: remarker.yml should be put in the current directory.)\n\nDefault settings are as follows:\n\n```yml\nport: 6275\ndest: build\nout: index.html\nsource: slides.md\ntitle: ''\nassets: ['assets']\ncss: ''\ncssFiles: []\nscript: ''\nscriptFiles: []\nremarkConfig: {}\nremarkPath: moduleDir + '/vendor/remark.js'\nscriptFilesAfterCreate: []\nlivereload: true\nlivereloadPort: 35729\n```\n\n## Basic options\n\n- `port` is the port number of remarker server. Default is `6275`.\n- `dest` is the destination of `remarker build` command. Default is `build`\n- `out` is the filename of the result html page. Default is `index.html`\n- `source` is the source markdown filename. Default is `slides.md`.\n- `title` is the page title of the slides. Default is an empty string.\n- `css` is css text you want to add to slides' html page.\n- `cssFiles` is the list of additional stylesheet files (URL or the file path\n  relative to your current working director) you want to add to slides' html\n  page. If you provide file paths, these files are copied/served statically.\n  Default is an empty array.\n\n## Advanced options\n\n- `assets` is the list of assets directory. These directories are copied/served\n  statically.\n- `scriptFiles` is the list of additional JavaScript files (URL or the file path\n  relative to your current working director) appended after the remark.js. If\n  you provide file paths, these files are copied/served statically. Default is\n  an empty array.\n- `script` is additional JavaScript code appended after the remark.js and\n  `scriptFiles`. Default is an empty string.\n- `remarkConfig` is the config object which is passed to remark.create(options).\n  Default is an empty object.\n  - See\n    [the remark source code](https://github.com/gnab/remark/blob/develop/src/remark/models/slideshow.js#L41-L48)\n    for what option is available.\n- `remarkPath` is the path to remark.js. This replaces the original remark.js\n  with specified one.\n- `scriptFilesAfterCreate` is the list of additional JavaScript files (URL or\n  the file path relative to your current working director) appended after the\n  `remark.create()`. If you provide file paths, these files are copied/served\n  statically. Default is an empty array.\n- `livereload` is the flag to toggle livereloading feature. Default is true.\n- `livereloadPort` is the port number for livereloading websocket connection.\n  Default is 35729.\n\n## CLI Usage\n\n\u003c!--\n  Notes: This help message is stored in //assets/help-message.txt\n  Please try keep these in sync.\n--\u003e\n\n```\nUsage:\n  remarker [options] serve      Serves all the assets at localhost\n  remarker [options] build      Builds all the assets to the dest\n\nOptions:\n  -h, --help                    Shows the help message and exits\n  -v, --version                 Shows the version number and exits\n  -s, --source \u003cpath\u003e           Specifies the slide's markdown file.\n                                This overrides 'source' property of the config file.\n  -o, --out \u003cfilename\u003e          The output filename of the slides. Default is index.html.\n  -d, --dest \u003cpath\u003e             The destination directory for built slides.\n  -p, --port \u003cnumber\u003e           The port number for dev server.\n  -b, --open-browser            Open the browser to the page when server starts. Default is false.\n```\n\n# Examples\n\n- [simple example](https://github.com/kt3k/remarker/tree/master/examples/simple)\n- [remark slides](https://github.com/kt3k/remarker/tree/master/examples/remark)\n  - The original `remark` slides in `remarker` configuration.\n- [LaTeX and Mathjax](https://github.com/kt3k/remarker/tree/master/examples/latex-mathjax)\n  - Usage of LaTeX and Mathjax in remarker. Contributed by @michaelliebling.\n\n# Motivation of `remarker`\n\n`remark` is a great presentation tool and you can write your slide's contents in\nmarkdown. The problem is when you simply use remark, you need to maintain the\nhtml, css and scripts as well as markdown. If you care the details of design and\nstyle of the slides, that's fine. However if you don't care the design of the\nslides that much and want to focus only on the contents, then the settings of\ncss, html, scripts seem quite messy. `remarker` solves this problem. `remarker`\nseparates the contents (= markdown) from the settings (css, html, scripts). So\nyou can only focus on and keep maintaining the contents of the slides and let\n`remarker` do the rest of the work. This is easier than using `remark` directly.\n\n# How-tos\n\n## How to use images in slides\n\nPut the images under `./assets` directory and they are automatically\nserved/copied and you can reference it like\n`\u003cimg src=\"assets/my-diagram.png\" width=\"600\" /\u003e` in your slides.\n\nThe directory name of `assets` can be configured in `remarker.yml`. See the\nconfiguration section for details.\n\n# Who uses this tool?\n\nSee [this search](https://github.com/search?q=filename%3Aremarker.yml).\n\n# History\n\n- 2022-11-24 v1.15.0 Added loading indicator.\n- 2022-02-13 v1.14.0 Fixed error while changing slides.md\n- 2020-05-11 v1.12.0 Added scriptFilesAfterCreate option.\n- 2019-10-18 v1.11.1 Fix dependency.\n- 2019-10-18 v1.11.0 Added `-b, --open-browser` option.\n- 2019-05-14 v1.10.0 Added `--dest`, `--out`, and `--port` CLI options.\n- 2018-08-06 v1.9.0 Added :emoji: transformation. Modify `cssFiles` option\n  handling (#11).\n- 2018-06-10 v1.8.1 Fixed help and version options.\n- 2018-06-10 v1.8.0 Added livereloading feature.\n- 2018-01-29 v1.7.0 Enabled file asset (#8).\n- 2018-01-13 v1.6.1 Fixed -s option.\n- 2018-01-12 v1.6.0 Added --source cli option.\n- 2017-08-05 v1.3.0 Added remarkConfig prop.\n\n# License\n\nMIT\n\n[remark]: https://github.com/gnab/remark\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkt3k%2Fremarker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkt3k%2Fremarker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkt3k%2Fremarker/lists"}