Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds support for .md files, can parse h tags, bold, italics, links and scratched #10

Merged
merged 3 commits into from
Sep 24, 2021

Conversation

ritikbheda
Copy link
Contributor

No description provided.

@vercel
Copy link

vercel bot commented Sep 21, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/dhillonks/cli-ssg/7Le9pnMdfTGSuPh37KnfvNaTVAX9
✅ Preview: https://cli-ssg-git-fork-ritikbheda-issue-9-dhillonks.vercel.app

Copy link
Owner

@dhillonks dhillonks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and works for .md files. However, I found a few issues while testing, please look into the following:

1. Paragraphs not generating properly

Most syntax guides (markdownguide, pandoc, github etc) all create paragraph tags for content separated for blank lines. For example: The two paragraphs below should be rendered with <p> tags
image
Also, text directly below a heading (h1..h6) should also be contained within <p> tags.

2. Use <strong> instead of <b>

Right now, bold text is rendered using the <b> tag. However, in accordance with most syntax guides, <strong> tags should be used instead.
image

3. Use <em> instead of <i>

Right now, italic text is rendered using the <i> tag. However, in accordance with most syntax guides, <em> tags should be used instead.
image

4. Direct links not working

Currently, inline links work properly however, it fails to render automatic links. As per the syntax guides, urls enclosed within angle brackets <> should be rendered as links. For example:
image

To-do:

  • Fix paragraph generation
  • Use strong tags for bold text
  • Use em tags for italic text
  • Add ability to render automatic links

@ritikbheda
Copy link
Contributor Author

solved in commit 78c4a
fixes #9
Note: I dont know why i cannot check the toDo list. But all of the points are covered in the above commit

@dhillonks dhillonks self-requested a review September 24, 2021 16:41
Copy link
Owner

@dhillonks dhillonks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good with the recent changes, could you also please modify the readme.md to include the .md. support in the Features.

@dhillonks dhillonks merged commit c66902c into dhillonks:main Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants