Live demo

[puzrin]

Probably, we need to provide live demo, like js-yaml does http://nodeca.github.io/js-yaml/ . There can be different code snippets & editable pre-filled examples. Users like, when they can touch result with hands :)

Any ideas about content?

[jonschlinkert]

I've used the js-yaml live demo a lot. that would be great!

how about using a markdown cheatsheet for content?

[puzrin]

Thanks for the link. Will use it for basic example.

I mean, demo should contain extended info - how to add macros, hot to add new tags and so on. All with code snippets and live examples.

[jonschlinkert]

demo should contain extended info - how to add macros.

Got it, I'd be happy to help put that together as we make progress.

[rlidwka]

I quickly copied demo from my older project, feel free to change that if you like:

http://jonschlinkert.github.io/remarkable/parser.html

I think this needs a logo...

[jonschlinkert]

nice! @rlidwka looks great! I'll add some styling when we get some content together.

[puzrin]

http://jonschlinkert.github.io/remarkable/demo/

I've added demo files and build scripts. see folder ./demo

• ./demo/data.yml - contains info to build demo blocks. Edit as you with.
• ./demo/index.jade - layout, static texts, demo grouping.
• run make to rebuild files.
• run make gh-pages to publish demo from current branch.

Rendering does not work yet, but you already can start to prepare data and tweak the look.

[jonschlinkert]

this is going to be a lot of fun to design around! nice work

[puzrin]

That's another concept of demo https://stackedit.io/ . May be one big text will be better.

[howardroark]

I like the idea of demoing the features by writing a narrative that walks someone through them. Just feels more human :)

Another example (great open-source tool as well)...
https://laverna.cc/index.html

[tunnckoCore]

Mm, previews not work?

[puzrin]

I've finished with demo http://jonschlinkert.github.io/remarkable/demo/ . IMHO it's ready to use, especially, with killer-feature permalink.

@jonschlinkert , consider replace initial text with something more short. Current one is a bit boring, when one come to demo many times. I'd like demo to be focused on developpers.

Sync scrolling postponed until better times. Don't like to spend time for it (and not interesting for me).

[puzrin]

Possible reduced example

[howardroark]

👍 for reduced. This is great!

[jonschlinkert]

that's great! I'll do some work on it in the next couple days. not to keep beating this drum, but I'm trying to wrap up assemble, and that's what I want to use for this! :-)

MHO it's ready to use, especially, with killer-feature permalink.

to be clear, you mean the demo specifically, not the library itself, correct?

[jonschlinkert]

and thanks! I'm really impressed with the amazing work you guys are doing!

[jonschlinkert]

and do you want me to start tweeting/mentioning this yet?

[puzrin]

to be clear, you mean the demo specifically, not the library itself, correct?

Demo only. It's "independent". I have no idea what to improve there.

and do you want me to start tweeting/mentioning this yet?

I'd prefer after 1-2 weeks. We still have to complete missed remarked/marked feature and refactor/polish architecture. Now it's "solid proof of concept", not "product".

[jonschlinkert]

got it, understood. thanks