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

Demo instructions are incomplete/confusing #531

Open
pdavis68 opened this issue Jul 10, 2024 · 2 comments
Open

Demo instructions are incomplete/confusing #531

pdavis68 opened this issue Jul 10, 2024 · 2 comments
Labels
enhancement Improvement request

Comments

@pdavis68
Copy link

The demo instructions at https://jfcere.github.io/ngx-markdown are as follows:


A demo is available @ https://jfcere.github.io/ngx-markdown and its source code can be found inside the demo directory.

The following commands will clone the repository, install npm dependencies and serve the application @ http://localhost:4200/

git clone https://github.com/jfcere/ngx-markdown.git
npm install
npm start

So a few things:

I can see that there's a demo directory, but it's unclear to me from the instructions, how to actually run the demo.
ngx-markdown

@jfcere
Copy link
Owner

jfcere commented Jul 10, 2024

Hi @pdavis68,

Thanks for your feedback, I'll do an update on the documentation based on your recommendations.

For the instruction on how to run the demo I'm not sure what to tell you, you've already found out by running npm start as demonstrated on your screenshot... the demo repertory is the website.

I'm sorry you've been confused but I'm glad you figured it all by yourself.

@pdavis68
Copy link
Author

LOL. Oh, I completely misunderstood. I was looking for like an editor where I'd edit some markdown and see the results. But now I see that the demo is rendering markdown. Thanks for clarifying.

@jfcere jfcere added the enhancement Improvement request label Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement request
Projects
None yet
Development

No branches or pull requests

2 participants