{"id":13688641,"url":"https://github.com/mark-when/mw","last_synced_at":"2025-05-06T16:20:05.383Z","repository":{"id":163096105,"uuid":"618483085","full_name":"mark-when/mw","owner":"mark-when","description":"Markwhen CLI","archived":false,"fork":false,"pushed_at":"2023-11-03T17:01:43.000Z","size":127,"stargazers_count":81,"open_issues_count":11,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-19T13:44:27.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mark-when.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"kochrt"}},"created_at":"2023-03-24T15:07:17.000Z","updated_at":"2025-03-09T07:46:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"66a688c2-504e-4624-a887-1a6528f76a05","html_url":"https://github.com/mark-when/mw","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mark-when%2Fmw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mark-when%2Fmw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mark-when%2Fmw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mark-when%2Fmw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mark-when","download_url":"https://codeload.github.com/mark-when/mw/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252721029,"owners_count":21793746,"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":[],"created_at":"2024-08-02T15:01:18.559Z","updated_at":"2025-05-06T16:20:05.359Z","avatar_url":"https://github.com/mark-when.png","language":"TypeScript","funding_links":["https://github.com/sponsors/kochrt"],"categories":["TypeScript"],"sub_categories":[],"readme":"# @markwhen/mw\n\n`mw` is the [markwhen](https://docs.markwhen.com) command line interface (CLI). You can use it to parse markwhen files and optionally render a view of it (timeline+gantt/calendar/resume).\n\nAll html output is self-contained; js and css are inlined and there are no external scripts.\n\n## Installation\n\n```sh\nnpm i -g @markwhen/mw\n```\n\n## Usage\n\n### Output HTML\n\n```sh\nmw [serve] \u003cinput_file\u003e [\u003cdestination\u003e] [-o \u003coutputType\u003e] [-d \u003cdestination\u003e] [-p \u003cport\u003e] [-s \u003csocket_port\u003e]\n```\n\n| Option        | Description                                                                                                                                                                                                                       |\n| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `serve`       | If provided, will start a server at the specified `port` and watch the `input_file` for changes                                                                                                                                   |\n| `outputType`  | one of `json` \\| `timeline` \\| `calendar` \\| `resume`                                                                                                                                                                             |\n| `destination` | File to write to. Output type can be inferred from the filename if `outputType` is not specified; i.e., files ending in `timeline.html` will produce the timeline view, files ending in `json` will produce the raw parse output. |\n| `port`        | If serving, port to serve from                                                                                                                                                                                                    |\n| `socketPort`  | If serving, socket port to serve from                                                                                                                                                                                             |\n\nParse markwhen document and output json:\n\n```sh\nmw project.mw\n# -\u003e outputs timeline.mw.json\n```\n\nRender a timeline view:\n\n```sh\nmw my_markwhen_file.mw timeline.html\n# -\u003e outputs timeline.html (timeline+gantt view)\n```\n\nRender a calendar view:\n\n```sh\nmw ThingsToDo.mw ThingsToDo-calendar.html\n# -\u003e outputs ThingsToDo-calendar.html (calendar view - inferred from the filename)\n```\n\n### Start a server and watch file\n\n`mw serve \u003cinput_file\u003e` will start a server and reflect changes to the input file.\n\nWatch `projects.mw` and get immediate updates in `localhost:3000`:\n\n```sh\nmw serve projects.mw -o calendar\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark-when%2Fmw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmark-when%2Fmw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark-when%2Fmw/lists"}