For example, this is the embedded summary of Paul Graham's essay, "The HardWare Renaissance":Check out a few real life examples
Good idea! You have three options. The first is the easiest but the other two work everywhere, not only Wordpress.
With the tldr.io Wordpress plugin, you only need to put the custom shortcode
[tldrio_embed] where you want the embedded summary of
your post to be. By default, if the summary has not yet been created, nothing will be displayed. You can change this in the plugin settings, so that
a link to tldr.io is displayed. That allows you to make sure the plugin works correctly. Once you make the summary, the default link will be replaced
by the embed.
You can also embed the summary of another article with the shortcode
[tldrio_embed someurl] where
someurl is the
url of the article whose summary you want to embed. For example if you want the same embed as the one at the top of this page:
If you're feeling lazy, the plugin even adds a 'tldr.io' button in your editor (you can see in the screenshots). Click on it to insert the
Make your blog awesome now! Install the plugin through your admin dashboard or download it.
If you don't have Wordpress, don't worry, this method and the next work everywhere. Wherever a tldr is displayed, you can easily get the HTML embed code. You can find it on the website and on the extension, and it's always at the same place: bottom right of the tldr:
Use this option for maximum flexibility or if you think the embed codes used in option #2 are too big. Here you need to use a small HTML code and choose the parameters you want to use with it.
To embed the tldr of your own post
To embed the tldr of another post and display the article title
As you can see, it's always the same code, in which you specify options using data attributes:
data-use-own-tldr="true"if you want to embed the summary of your own post
data-url="some_url"if you want to embed the summary an arbitrary url (if no tldr exists for the url the embed wil stay invisible). You can also use
data-url="this page"to get the same behaviour as the above option
data-show-title="true|false"if you want to show the title of the article in the embed (defaults to false)
A few real life examples: