Skip to content
New issue

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

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

Already on GitHub? # to your account

chore(fix): Fix some problems with demo quickref #1682

Closed
wants to merge 2 commits into from

Conversation

hughsw
Copy link
Contributor

@hughsw hughsw commented May 19, 2020

Marked version:

npm: 1.1.0

Markdown flavor: n/a

Description

  • Fixes bugs and typos in demo/quickref.md

Expectation

Documentation will have correct English, all examples will work

Result

There are a couple of typos, and some of the examples don't work

What was attempted

I'm learning marked -- it's my first time looking at the docs

Contributor

  • I'm new to this project; I don't know if/how your demos are tested...
  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

@vercel
Copy link

vercel bot commented May 19, 2020

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/markedjs/markedjs/cl4116sce
✅ Preview: https://markedjs-git-fork-hughsw-hughsw-patch-1.markedjs.now.sh

Copy link
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

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

Thanks for this! There are a few things to fix.

Comment on lines 120 to 121
and find that it's just wrapped in a `<p>` tag and *won't* be shown
as preformatted text.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
and find that it's just wrapped in a `<p>` tag and *won't* be shown
as preformatted text.
and find that it's just wrapped in a `<p>` tag and *won't* be shown
as preformatted text.

Comment on lines +123 to 126
You can keep adding more and more paragraphs to a single
list item by adding the traditional blank line and then keep
on indenting the paragraphs with four spaces. You really need
to only indent the first line, but that looks ugly.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You can keep adding more and more paragraphs to a single
list item by adding the traditional blank line and then keep
on indenting the paragraphs with four spaces. You really need
to only indent the first line, but that looks ugly.
You can keep adding more and more paragraphs to a single
list item by adding the traditional blank line and then keep
on indenting the paragraphs with four spaces. You really need
to only indent the first line, but that looks ugly.

@@ -130,7 +133,7 @@ to only indent the first line, but that looks ugly.

- Lists support preformatted text

You just need to indent eight spaces.
You just need to indent eight spaces.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You just need to indent eight spaces.
You just need to indent six spaces.

@UziTech
Copy link
Member

UziTech commented Jun 24, 2020

@hughsw are you interested in continuing with this PR?

@UziTech UziTech mentioned this pull request Jul 13, 2020
6 tasks
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants