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.

Sign up for GitHub

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

Jump to bottom

Add support for basic html tags #93

Open
dcastro opened this issue Oct 31, 2021 · 9 comments · May be fixed by #259
Open

Add support for basic html tags #93

dcastro opened this issue Oct 31, 2021 · 9 comments · May be fixed by #259
Assignees
@Sereja313
Labels
feature New functionality
Milestone
0.3.0

Comments

@dcastro
Copy link
Member

dcastro commented Oct 31, 2021 •
edited
Loading

Clarification and motivation

HTML tags can be used in a markdown file.

For example, in our own readme, we have a <img> tag:

<img src="https://user-images.githubusercontent.com/5394217/70820564-06b06e00-1dea-11ea-9680-27f661ca2a58.png" alt="Output sample" width="600"/>

We should add support for basic HTML tags (embedded in markdown files), such as:

  • images: <img src="link">
  • anchors hyperlinks: <a href="link">Text</a>
  • anchor target locations: <a name="loc"> or <a id="loc">
    • we already support anchor target locations in markdown headers (see example), but now we should support them everywhere

We should investigate which other tags we want to support.

Acceptance criteria

xrefcheck verifies whether anchors and image tags (and possibly others) are valid.
@Martoon-00
Copy link
Member

Oh, that's an interesting point.

Checking images would indeed be helpful, if we succeed to implement #92.

Anchors are handled at the moment, but it would be really nice to see which other HTML tags can make sense in the documentation. E.g. I often use spoilers, but here we probably don't have anything to verify...

@dcastro
Copy link
Member Author

dcastro commented Nov 3, 2021

Anchors are handled at the moment

I don't think we handle anchor tags at the moment. We do handle <a name="some-name"> in headers, but that's it.

From tests/markdowns/without-annotations/anchors_in_headers.md:

## <a name="stuff-section"></a> Some stuff

[My link](#stuff-section)

@dcastro
Copy link
Member Author

dcastro commented Nov 3, 2021

On that point, we should also support for target locations (i.e. <a name="loc">) outside of headers too.

@dcastro dcastro added the feature New functionality label Nov 3, 2021
@dcastro dcastro added this to the 0.3 milestone Sep 17, 2022
@Sereja313 Sereja313 self-assigned this Sep 29, 2022
@Martoon-00
Copy link
Member

@Sereja313 now switched to another project, he likely won't be able to work on this task.

@Sereja313 if you have begun working on it and have something to share, or if you suddenly come to implement this issue for some personal preference, I dunno, please mention this here.

@Sereja313
Copy link
Member

@Martoon-00 I'm going to finish the PR for this issue this week.

@Sereja313 Sereja313 self-assigned this Nov 16, 2022
@Martoon-00
Copy link
Member

Ah, great then 👍

@Martoon-00
Copy link
Member

@Sereja313 How is it going?

If you see that you completely lack time, feel free to just leave a WIP PR where part of the work is done.

@Sereja313
Copy link
Member

Yes, I've been a bit busy, sorry... I'll have some free time tomorrow.

Sereja313 added a commit that referenced this issue Dec 23, 2022
@Sereja313
[#93] Add support for basic html tags
2430b54 
Problem: HTML tags can be used in a markdown file. We should add
support for basic HTML tags embedded in markdown file.

Solution: Add support for image tags (<img src="link">), anchor
hyperlinks (<a href="link">Text</a>) and anchor target
locations (<a name="loc"> or <a id="loc">).
@Sereja313 Sereja313 linked a pull request Dec 23, 2022 that will close this issue
Open
13 tasks
Sereja313 added a commit that referenced this issue Dec 23, 2022
@Sereja313
fixup! [#93] Add support for basic html tags
d863dcf
@Martoon-00
Copy link
Member

Great, thanks for posting the PR 👍

I think we will take it from now on (unless you'd like to follow the PR until it's merged).

Sereja313 added a commit that referenced this issue Dec 28, 2022
@Sereja313
fixup! fixup! [#93] Add support for basic html tags
15caf4b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Sereja313 Sereja313

Labels
feature New functionality
Projects
None yet
Milestone
0.3.0
Development

Successfully merging a pull request may close this issue.

[#93] Add support for basic html tags serokell/xrefcheck
3 participants
@dcastro @Martoon-00 @Sereja313