Demo instructions are incomplete/confusing

[pdavis68]

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:

• The link takes you to the page you're already on.
• The instructions are lacking cd ngx-markdown after the git clone line.
• I had to do npm install --legacy-peer-deps
• Going to http://localhost:4200 takes you to page that looks identical to the page at https://jfcere.github.io/ngx-markdown.

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

[jfcere]

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]

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.