https://github.com/nix7amcm/fcc-markdown-previewer
This is my Markdown Previewer project for FreeCodeCamp's Front End Development Libraries Certification. I build this using React and Bootstrap, with Marked Library to parse the markdown.
https://github.com/nix7amcm/fcc-markdown-previewer
bootstrap emoji-js freecodecamp freecodecamp-project marked-js react
Last synced: 3 months ago
JSON representation
This is my Markdown Previewer project for FreeCodeCamp's Front End Development Libraries Certification. I build this using React and Bootstrap, with Marked Library to parse the markdown.
- Host: GitHub
- URL: https://github.com/nix7amcm/fcc-markdown-previewer
- Owner: Nix7amcm
- Created: 2024-02-06T20:47:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T22:10:20.000Z (over 2 years ago)
- Last Synced: 2026-01-01T01:14:27.823Z (6 months ago)
- Topics: bootstrap, emoji-js, freecodecamp, freecodecamp-project, marked-js, react
- Language: JavaScript
- Homepage: https://markdown-previewer-qv96.onrender.com/
- Size: 1.37 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Previewer
This is a project for the freeCodeCamp Front End Libraries Certification. The project is a markdown previewer that allows the user to input markdown and see the rendered HTML output. The project uses React and the Marked library to parse the markdown.
---
## Images:
#### Desktop
#### Tablet
#### Mobile
* * *
## Project Description:
**Objective:** Build an app that is functionally similar to this: [https://markdown-previewer.freecodecamp.rocks/](https://markdown-previewer.freecodecamp.rocks/).
Fulfill the below user stories and get all of the tests to pass. Use whichever libraries or APIs you need. Give it your own personal style.
You can use any mix of HTML, JavaScript, CSS, Bootstrap, SASS, React, Redux, and jQuery to complete this project. You should use a frontend framework (like React for example) because this section is about learning frontend frameworks. Additional technologies not listed above are not recommended and using them is at your own risk. We are looking at supporting other frontend frameworks like Angular and Vue, but they are not currently supported. We will accept and try to fix all issue reports that use the suggested technology stack for this project. Happy coding!
---
### User Stories
- [x] **User Story #1:** I can see a `textarea` element with a corresponding `id="editor"`.
- [x] **User Story #2:** I can see an element with a corresponding `id="preview"`.
- [x] **User Story #3:** When I enter text into the `#editor` element, the `#preview` element is updated as I type to display the content of the textarea.
- [x] **User Story #4:** When I enter GitHub flavored markdown into the `#editor` element, the text is rendered as HTML in the `#preview` element as I type (HINT: You don't need to parse Markdown yourself - you can import the Marked library for this: [marked - Libraries - cdnjs - The #1 free and open source CDN built to make life easier for developers](https://cdnjs.com/libraries/marked)).
- [x] **User Story #5:** When my markdown previewer first loads, the default text in the `#editor` field should contain valid markdown that represents at least one of each of the following elements: a heading element (H1 size), a sub heading element (H2 size), a link, inline code, a code block, a list item, a blockquote, an image, and bolded text.
- [x] **User Story #6:** When my markdown previewer first loads, the default markdown in the `#editor` field should be rendered as HTML in the `#preview` element.
- [x] **Optional Bonus (you do not need to make this test pass):** My markdown previewer interprets carriage returns and renders them as `br` (line break) elements.
---
## Additional Notes:
You can build your project by [using this CodePen template](https://codepen.io/pen?template=MJjpwO) and clicking `Save` to create your own pen. Or you can use this CDN link to run the tests in any environment you like: `https://cdn.freecodecamp.org/testable-projects-fcc/v1/bundle.js`
Once you're done, submit the URL to your working project with all its tests passing.
**Note:** React 18 has known incompatibilities with the tests for this project (see [issue](https://github.com/freeCodeCamp/freeCodeCamp/issues/45922))