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.

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

Add built-in shortcodes for common usecases #1576

Closed
5 tasks done
digitalcraftsman opened this issue Nov 15, 2015 · 8 comments
Closed
5 tasks done

Add built-in shortcodes for common usecases #1576

digitalcraftsman opened this issue Nov 15, 2015 · 8 comments

Comments

@digitalcraftsman
Copy link
Member

Why shouldn't we add a number of shortcodes for the most popular usecases and services. New users could use them out of the box without the need of creating them manually.

Follow the forum discussion for more information.

Just a quick compilation of usecases / services (todo list):

  • Twitter
  • Speakerdeck presentations
  • YouTube videos
  • Vimeo videos
  • Github gists
@derekperkins
Copy link
Contributor

@digitalcraftsman - that's a good idea and not particularly difficult to implement. If you could figure out what the input options should be and sample output, that'd make it a piece of cake.

@digitalcraftsman
Copy link
Member Author

@derekperkins - below you find a list of the syntax that user would use to call the shortcodes. Do you think that something could be improved?

Twitter

To embed a single tweet the user needs to pass a username and the id of the tweet:

{{< tweet spf13 666616452582129664 >}}

Speakerdeck

Required is the id of the slide. This id can be found on the right side of the presentation on Speakerdeck under 'Direct link'

{{< speakerdeck 4e8126e72d853c0060001f97 >}}

YouTube

Just the id of the video is required:

{{< youtube w7Ft2ymGmfc >}}

Vimeo

Just the id of the video is required:

{{< vimeo 146022717 >}}

Gists

Gists would need the owner's username and its unique id:

{{< gist digitalcraftsman 85f59771b5ae1e2091a8 >}}

@bep
Copy link
Member

bep commented Nov 20, 2015

A comment for the documentation: You only need quoted parameters if you have spaces or very special chars, so this is better:

{{< youtube w7Ft2ymGmfc >}}

@digitalcraftsman
Copy link
Member Author

Thanks for annotating this. I'll update the examples above.

@digitalcraftsman
Copy link
Member Author

All shortcodes are implemented (including Twitter) and the docs have been written.

@bep bep closed this as completed in 86dcac6 Nov 24, 2015
@derekperkins
Copy link
Contributor

Awesome!

bramp pushed a commit to bramp/hugo that referenced this issue Dec 17, 2015
@umtksa
Copy link

umtksa commented Jul 23, 2017

how about responsive vimeo and youtube
i have some custom shortcodes here

tychoish pushed a commit to tychoish/hugo that referenced this issue Aug 13, 2017
bep added a commit that referenced this issue Dec 8, 2021
316cec249 Update future events template example (#1595)
3bde7d489 Install mage outside module (#1592)
762e27eff Clarify ignoreFiles regex matching
4d0032051 Add id attribute to h2 elements (#1590)
8262b077c Improve inline resource examples (#1587)
2eae7c7ec fix disqus example name (#1588)
a772f4804 Added install instructions for openSUSE Tumbleweed (#1459)
7ad1c301b Remove screen capture from Hosting on GitHub page (#1586)
a58541f49 add more details on about gh-pages and baseURL on hosting-on-github.md (#1346)
3bd0b46dc Update configuration page (#1585)
4cf1f013e Update OS functions
2c45a95c2 Remove getting-started/code-toggle/
40fdff598 Describe artificial language private use subtags (#1577)
91011d210 Remove google_news from list of internal templates (#1576)
36c7879e4 Update the .Unix function
731063488 Remove a showcase
818c371a0 Update index.md
3136d39d9 netlify: Hugo 0.89.4
092bc9278 Merge branch 'tempv0.89.4'
18e01f105 releaser: Add release notes to /docs for release of 0.89.4
79135281f Correct and sort list of target image formats (#1574)
af4170c7e netlify: Hugo 0.89.3
7f5444251 Merge branch 'tempv0.89.3'
a32e4a6c2 releaser: Add release notes to /docs for release of 0.89.3
6dd3dc3f9 Update configuration.md
5fbe741d7 Update index.md (#1570)
37a69496f netlify: Bump to Hugo 0.89.2
3b293f1f4 Merge branch 'tempv0.89.2'
64c934e7a releaser: Add release notes to /docs for release of 0.89.2
919c51c7d Update index.md
13dd463b1 netlify: Hugo 0.89.1
d8cda1474 releaser: Add release notes to /docs for release of 0.89.1
a2adf7742 releaser: Add release notes to /docs for release of 0.89.1
c3088c4fc Add code toggle to menus page (#1568)
2d0f38978 Remove blank lines from code-toggle output (#1564)
7cf058bfd Add localization examples (#1563)
cf8627c2e Fixing typos, fixing incomplete link (#1561)
c78cc014b Document the removePathAccents setting
70beddaf4 Make corrections to 0.89.0 release notes (#1560)
1917195f0 Update index.md
7fb8e070c Run hugo --gc
1772d45fb Release 0.89.0
d9006179b Merge branch 'tempv0.89.0'
8db86b61e releaser: Add release notes to /docs for release of 0.89.0
abf268571 docs: Regen CLI docs
fbbdb0ab1 Update the timeout default
9cbd1c15a Fix description of lang.FormatNumberCustom
6043b54cc Remove "render" keyword from Host on Render page
f8ea8e84f Clarify description of front matter url (#1557)
91a0c9954 Update Twitter shortcode oEmbed endpoint
79a7405b8 Merge commit 'aa5ac36a3eb68b86c803caec703869efefc8447e'
57667bae6 hugofs: Add includeFiles and excludeFiles to mount configuration
0c9ee0a04 Allow multiple plugins in the PostCSS options map
155799e6b docs: Create path.Clean documentation

git-subtree-dir: docs
git-subtree-split: 316cec2494dc5f908283289371d74f36a73d3d8d
@github-actions
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants