From bacf2d3cd6820373877b527ab22ec49e38c5c99d Mon Sep 17 00:00:00 2001 From: Florin Pop Date: Sun, 3 Mar 2019 22:18:15 +0200 Subject: [PATCH] new project: Markdown Previewer --- Projects/Markdown-Previewer.md | 24 ++++++++++++++++++++++++ README.md | 1 + 2 files changed, 25 insertions(+) create mode 100644 Projects/Markdown-Previewer.md diff --git a/Projects/Markdown-Previewer.md b/Projects/Markdown-Previewer.md new file mode 100644 index 00000000..c6396459 --- /dev/null +++ b/Projects/Markdown-Previewer.md @@ -0,0 +1,24 @@ +# Markdown Previewer + +Convert Github flavored markdown into HTML code. + +## User Stories + +- [ ] User can enter Github flavored markdown into a text area +- [ ] User can see the resulting HTML in another container/box + +## Bonus features + +- [ ] When closing the browser window the markdown formatted text will be stored and when the User returns, the data will be retrieved +- [ ] User can click a button and the content of the box is saved to the clipboard + +## Useful links and resources + +- [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) +- [Markdown Guide](https://www.markdownguide.org/basic-syntax/) +- [Marked - A markdown parser](https://github.com/markedjs/marked) +- [How to Copy to Clipboard](https://www.w3schools.com/howto/howto_js_copy_clipboard.asp) + +## Example projects + +- [Markdown Live Preview](https://markdownlivepreview.com/) diff --git a/README.md b/README.md index e3ddc383..a2a8f216 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Each project has the following **features**: | ------------------------------------------------------------------ | | [Book Finder App](./Projects/Book-Finder-App.md) | | [Kudos Slackbot](./Projects/Kudos-Slackbot.md) | +| [Markdown Previewer](./Projects/Markdown-Previewer.md) | | [Markdown Table Generator](./Projects/Markdown-Table-Generator.md) | | [Notes App](./Projects/Notes-App.md) | | [Pomodoro Clock](./Projects/Pomodoro-Clock.md) |