CODEWITHSUNDEEP
githubrestructuredtextstrikethrough
Santosh Kumar
Santosh Kumar

Reputation: 27885

How to do strikethrough in a reStructuredText file hosted on GitHub?

I am converting a README.md file to README.rst. The reason is, I am going to make a package available to PyPi. I am forced to use .rst.

My conversion is nearly complete, but I have a strikethrough line in my markdown file, e.g.:

~~This text is crossed out~~

which renders on GitHub as crossed out. But I am unable to do this in reStructuredText. A similar post on StackOverflow suggests defining a strike like this:

.. role:: strike
    :class: strike

And using something like this in the CSS file:

.strike {
  text-decoration: line-through;
}

And do strikethrough like this:

:strike:`This text is crossed out`

But the problem is I have no control over CSS file of GitHub.

Upvotes: 18

Views: 3100

Answers (4)

Dash2TheDot
Dash2TheDot

Reputation: 157

Or you can use https://www.thefancytext.com/strikethrough-text-generator.

S̶t̶r̶i̶k̶e̶o̶u̶t̶

Ain't fancy, but if you copy and paste it in your editor, pandoc should take it.

Upvotes: 1

Hal W
Hal W

Reputation: 186

You can also use substitutions to make multiple uses easier. Put this markup somewhere in your file:

.. |ss| raw:: html

   <strike>

.. |se| raw:: html

   </strike>

Then just enclose the text to be struck out with |ss| & |se|:

One, |ss| two |se|, three |ss| strikes |se| you're out!

will render as:

One, two , three strikes you're out!

Just be sure to have space around the substitution elements, so they are parsed correctly. It looks a bit awkward here, but this is a contrived example.

Upvotes: 14

Praveen Kumar
Praveen Kumar

Reputation: 1310

Not so clean solution, but works for me.

.. raw:: html

   <s>

This text is crossed out

.. raw:: html

   </s>

Upvotes: 5

Matthew McCullough
Matthew McCullough

Reputation: 17597

This is not possible right now as the Markdown equivalent is top level GitHub Flavored Markdown syntax, whereas with the RST it is a document-specific style. On GitHub's repository rendering, there are currently no CSS additions permitted.

Upvotes: 3

Related Questions