Skip to content

Make a cascading timeline from markdown-like text. Supports simple American/European date styles, ISO8601, images, links, locations, and more.

License

Notifications You must be signed in to change notification settings

aaparmeggiani/markwhen

 
 

Repository files navigation

Markwhen is an interactive text-to-timeline tool. Write markdown-ish text and it gets converted into a nice looking cascading timeline.

Use the editor here.

This repo is for the renderer, not the editor. The editor (markwhen.com) and VSCode extension are built on top of the renderer.

Links
Parser https://github.com/mark-when/parser
Editor https://markwhen.com
Documentation https://docs.markwhen.com
Blog https://blog.markwhen.com
VSCode extension https://marketplace.visualstudio.com/items?itemName=Markwhen.markwhen

Get updated

If you'd like to be kept up-to-date about markwhen's feature development, add your email here.


VSCode Extension

Get the VSCode extension here.

To switch between the text editor and the timeline view, select View: Reopen editor with... from the command palette and choose Text Editor.


Quick start

> git clone [email protected]:mark-when/markwhen.git
> cd markwhen
> npm i
> npm run dev

The renderer renders whatever is given to the markwhenStore.

To enable editing from the timeline view, set editorOrchestrator.editable to true:

const editable = ref(true);

Dockerized

> git clone [email protected]:mark-when/markwhen.git
> cd markwhen
> docker build -t markwhen .
> docker run -p8080:8080 markwhen

This should build a development markwhen image from the Dockerfile and run it on port 8080. Once running, it should be available at http:https://localhost:8080

Documentation

Documentation is located here.

About

Make a cascading timeline from markdown-like text. Supports simple American/European date styles, ISO8601, images, links, locations, and more.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 64.2%
  • TypeScript 19.9%
  • Vue 15.6%
  • Other 0.3%