https://github.com/devidw/hugo-theme-component-oembed

Static oEmbed endpoint for Hugo websites

https://github.com/devidw/hugo-theme-component-oembed

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.2%) to scientific vocabulary

Keywords

endpoint hugo hugo-theme-component json oembed static
Last synced: 4 months ago · JSON representation

Repository

Static oEmbed endpoint for Hugo websites

Basic Info
  • Host: GitHub
  • Owner: devidw
  • License: gpl-3.0
  • Language: HTML
  • Default Branch: master
  • Homepage:
  • Size: 16.6 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Topics
endpoint hugo hugo-theme-component json oembed static
Created about 4 years ago · Last pushed almost 4 years ago
Metadata Files
Readme License

README.adoc

= Hugo Theme Component: oEmbed
David Wolf 

Add a static oEmbed endpoint to your hugo website by generating a oEmbed file for each of your posts.

Currently supported oEmbed content types:

* `link`

== Installation
Add the theme component as submodule to your hugo prject:

[source,zsh]
----
git submodule add https://github.com/devidw/hugo-theme-component-oembed.git ./themes/hugo-theme-component-oembed
----

// == Configuration
// …

== Setup
Specify the output format in your `config.yaml` file:

[source,yaml]
----
outputFormats:
  # hugo-theme-component-oembed
  oembed:
    name: "oembed"
    baseName: "oembed"
    mediaType: "application/json"
    isPlainText: true
----

Also add the output format to the `outputs` array:

[source,yaml]
----
outputs:
  home: 
    # …
    - OEMBED # hugo-theme-component-oembed
  page:
    # …
    - OEMBED # hugo-theme-component-oembed
----

Include the `oembed.html` partial in the `` of you themes template file, for example `baseof.html`:

[source,go]
----
{{/* hugo-theme-component-oembed */}}
{{ partial "oembed.html" . }}
----

This will create a link like the following on page build:

[source, html]
----

----


== Usage
Exlude a page from the oEmbed output:

[source,yaml]
----
notoembed: true
----


== Resources
* https://oembed.com[oEmbed]
* https://halfelf.org/2021/oembedding-hugo/[oEmbedding Hugo]

Owner

  • Name: David Wolf
  • Login: devidw
  • Kind: user
  • Location: The Zone

// uncommenting

GitHub Events

Total
Last Year

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 7
  • Total Committers: 1
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
David Wolf 6****w 7

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rocky-III (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels