Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Live codedoc code demo #26

Closed
TysonMN opened this issue Jun 13, 2020 · 3 comments
Closed

Live codedoc code demo #26

TysonMN opened this issue Jun 13, 2020 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@TysonMN
Copy link
Contributor

TysonMN commented Jun 13, 2020

Codedoc's code blocks are largely based on Marked (c.f. #25), but there are some differences (achieved via preprocessing).

Just like it is possible to demo Marked, is there a page where it is possible to demo codedoc's code blocks?

@loreanvictor
Copy link
Contributor

Perhaps it would be possible, but definitely not as trivial:

  • you can have custom components, so you would either have to drop support for custom components on such a demo page, or be able to re-bundle client-side code.
  • you would also need to be able to try out custom components I suppose?
  • a lot of behavior of CODEDOC's own components are shipped via client-side scripts, which would need to be properly re-applied when the source markdown changes.

anyways I suspect this issue is perhaps more related to this repository, though generally it would be a nice thing to have such a demo page (at least with the standard set of components) for CODEDOC specifically.

@TysonMN
Copy link
Contributor Author

TysonMN commented Jun 13, 2020

Yes. This is definitely a "nice-to-have" tool. As I think you implied somewhat there, this is useful even if it doesn't support all the features possible when used in the complete environment of a user's website.

@loreanvictor loreanvictor added enhancement New feature or request help wanted Extra attention is needed labels Jun 13, 2020
@loreanvictor
Copy link
Contributor

on further thought, I would think this is best implemented as a stand-alone project. CODEDOC might need to export/expose more of its internal machinery for such a project to work nicely, but I do not think this should be part of CODEDOC core itself (separation of concerns).

as a result, I am closing this issue, though this is definitely a nice idea that should be implemented independently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants