How to read the markdown files in ReactJS
What is Markdown?
Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages. ".MD" is the file extension.
What are the advantages of Markdown file.
- 1. Markdown is easy to read and write.
- 2. Writers and publishers love writing with Markdown as it reduces distractions.
- 3. It's intentionally simple.
- 4. Lets you focus on important things and increases productivity.
- 5. Converts plain text into HTML.
- 6. Multi-platform.
- 7. It doesn't break.
- 8. Online markdown editors also available so easy to create it.
There are lot of markdown editors are available, if you are an expert then notepad is enough to write the contents on markdown file.
How to read/load the markdown aka .md files in ReactJS
We going to use the NPM package to read the markdown or .md file. Currently many NPM pacakges are available to read the .md file, among that "marked" package we imported.
Step 1.
Initialize the project
npx create-react-app markdownsample
Step 2.
Add the package
npm i marked
Step 3.
create a .md file and name it readme.md or anything as your wish under the src folder.
Step 4.
Edit the App.js, were we added the logics
import React, { useEffect, useState } from "react";
import readmePath from "./README.md";
import { marked } from "marked";
function App() {
const [data, setData] = useState("");
useEffect(() => {
fetch(readmePath)
.then((response) => {
return response.text();
})
.then((text) => {
setData(marked(text));
});
}, []);
return (
<React.Fragment>
<article dangerouslySetInnerHTML={{ __html: data }} />
</React.Fragment>
);
}
export default App;
Here we imported the readme.md file and read using fetch function. fetch function read the file into text. Once it is responded as text, it is passed as an argument to the "marked" function and directly set the result to state variable.
Finally state variable rendered to the article html element.
then the result would be like this in the below screenshot
Conclusion
The above program snippet is helping to read and render the markdown or .md file. Also you can fork the project from the given Github link.
More Stories
Cross-Origin Resource Sharing (CORS) is a security feature that lets a web page from one domain request resources from a different domain
SVG elements will not add the accessibility atttributes by default, so that will fail to describe by itself, and the NVDA and other screen reader required these attributes to work.
Despite being acquainted with git, many developers struggle to resolve these conflicts due to a lack of understanding of how to pull the conflict details into their local machines.
Firebase Authentication is one of its gems, allowing you to add user authentication effortlessly. It's secure, reliable, and comes with Google's seal of approval.
![[Solved] Firebase auth/invalid-api-key error when setting the values in the environment variable on NextJS?](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Fenv-variable-thump.jpg&w=3840&q=50)
Why am I getting an auth/invalid-api-key error when setting the Firebase values in the environment variable on NextJS ?
Enzyme Internal Error: Enzyme expects an adapter to be configured, but found none.
![[Solved] How to download SVG as PNG file](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Fsvg-to-png-thumb.jpg&w=3840&q=50)
Easist way of downloading the SVG file as PNG file is done using javascript snippet
To keep the code is safe and distrubuted between multiple resources that been achieved with the help of GIT
The importance of the http response headers are highly needed to protect the websites from hackers. If you poorly managed the response header then one day the website will be compromise to the hacker.
An HTTP header is a response by a web server to a browser that is trying to access a web page.
![[Solved] How to create Application insight access token](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Faccess-key-thump.jpg&w=3840&q=50)
Application Insights is an feature of Azure Monitor and it provides application performance monitoring features. APM tools are very useful to analyse applications from development, testing and production release.
A lazy function lets you defer the loading of a components code until it is rendered for the first time. Before, it will remain in the bundle. So that we can reduce the load of the application.
We covered most asked questions for Javascript interview and their answers
we are displaying these emojis with the help of ASCII code and it is not that easy to remember because its a mix of numeric and special characters.
ES6 or the ECMAScript 2015 is the major edition of ECMAScript language, it introduced several new features which are very special to the developers
what are the new features among the various versions of ECMA script and what is difference
![[Solved] How to squash the number of commits from a branch in Git](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Fdelete-commits-git-thump.jpg&w=3840&q=50)
We can squash the number of commits from a git branch
![[Solved] Your focus-trap must have at least one container with at least one tabbable node in it at all times](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Ffocus-trap-thumb.jpg&w=3840&q=50)
Your focus-trap must have at least one container with at least one tabbable node in it at all times, when using dialog or modal in ReactJS or other front-end framework
Writing test cases for modal popup in jest
![[Solved] Uncaught TypeError: Cannot read property 'location' of undefined](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2FuseLocation_testcases-thump.jpg&w=3840&q=50)
Cannot read property location of undefined, this is an common test cases error in react jest while using useLocation hook in your react component
![[Solved] Missing ID attributes in markdown to html](/_next/image?url=%2Fassets%2Fblog%2Fcovers%2Fmark-id-missing-thumb.jpg&w=3840&q=50)
There is a common problem when parsing the markdown file the ID attribute is missing in the element, here we found a solution to fix/overcome
It is basicall demonstrating how to find the fibanocci, amstrong, prime numbers and pyramid pattern using javascript.
There are few development tips for Javascript array operation, these tips will reduce your development time.
For every website the Sitemap will be playing important role for SEO performance. In Ecommerce and other consumer websites also SEO have important role for developing their revenue.
This question is very usual, to get solve this issue by using the browser property user agent to check whether the device type.
What are the possible ways to create objects in JavaScript, The traditional way to create an empty object is using the Object constructor. But currently this approach is not recommended.