expressive-code / expressive-code

A text marking & annotation engine for presenting source code on the web.

Home Page:https://expressive-code.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs: Missing demo and examples

krzkaczor opened this issue · comments

This project looks great but docs desperately need examples/demo section. I get that you use expressive-code in the docs so it's kinda a demo but I would love to see a dedicated showcase of what's possible.

Hello and welcome! Thank you for this docs idea.

As you have mentioned, the docs already use Expressive Code everywhere, and in the various pages of the "Key Features" and "Optional Plugins" sections of the main navigation, the features get showcased and explained with code & rendered result pairs.

For example, this page shows all the available features to highlight lines and terms: https://expressive-code.com/key-features/text-markers/

Could you please elaborate on what type of examples you are missing?

@hippotastic Yes, the text markers subpage looks great. The only problem is that it's buried in docs and as a user who just learned about your lib, I don't want to scroll through multiple subpages only to see what's possible.

I simply suggest creating a "demo" or "examples" page showcasing the most advanced features.

Gotcha, good idea! This would probably serve as a good introduction page, which I'm currently missing. I'll try to come up with something along these lines.

Thanks for your input!