Markdown Previewer

The markdown previewer takes markdown typed into the field on the left hand side of the page and translates it into its HTML equivalent and displays it on the right side of the page.

To Use

Type github-flavored markdown into the field on the left and view your translated text on the right.

Contributing

This project is still in active development. Development is based on the development branch. To contribute, follow these steps:

git clone https://github.com/matty22/MarkdownPreviewer.git
git checkout development
git checkout -b issue-label/reference-to-issue (ex. bug/fix-grammar-error)

Make your changes in your local copy...

git add [filename].ext
git commit -m "Concise message that explains your changes"
git checkout development
git pull
git checkout fix/my-branch
git merge development
git push origin fix/my-branch

Then, open a PR on the development branch on the repo.

For questions, read these three blog posts for guidelines on how to contribute:

"How to not f- up your local files with Git Part 1, Part 2, and Part 3"

Angular CLI commands

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

matty22/MarkdownPreviewer