Skip to content

Docs Update: HTML Wrappers in markdown #1293

Open
@jhildenbiddle

Description

@jhildenbiddle

Feature request

It may be worth adding a note to the docs that describes using HTML wrappers in markdown for targeting elements for CSS or JavaScript.

For example, wrapping a markdown table in a <div> element with a class:

<div class="highlight">

| Header | Header  |
| -------| ------- |
| Cell   | Cell    |
| Cell   | Cell    |

</div>

Will allow that specific table to be targeted with the following CSS:

.highlight table {
  border: 2px solid red;
}

The only concern is that while this works with docsify's current markdown processor, other markdown processors may not handle blocks of HTML & markdown the same way. If docsify decides to change markdown processors in the future, this functionality could break. Just something to consider.

What problem does this feature solve?

Docsify site owners often want to target specific elements, but markdown provides no standardized mechanism for adding attributes to elements and docsify only offers this functionality on a handful of elements via helpers. This addresses that problem without using docsify-specific markup that may be unintentionally rendered in other environments (GitHub, GitLab, etc.).

What does the proposed API look like?

Just a docs update.

How should this be implemented in your opinion?

Docs update.

Are you willing to work on this yourself?

Sure.

Metadata

Metadata

Assignees

Labels

enhancementpinnedThis is to pinned the PR/Issue in order to keep it open

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions