References

Last Edit: 2025.01.24

Hugo Default

By default, Hugo can create references using standard markdown syntax. This default usage will continue to work, and is not impacted by this theme. Only pages using the references shortcode will utilize the Shock theme reference functionality.

### Example Reference Line
"Linux is a family of open-source Unix-like operating systems based on the Linux kernel."[^wikipedia-linux]

### Example Reference Citation
[^wikipedia-linux]: Wikipedia. "[Linux](https://wikipedia.org/wiki/Linux)." 2025.

“Linux is a family of open-source Unix-like operating systems based on the Linux kernel.”1

Assets

The references functionality in this theme uses the assets directory to store references at a single location. This allows easy management and prevents duplicated references.

Store references in markdown files within the assets/references directory. Some example paths are as follows, names of the markdown files are not important.

  • assets/references/example.md
  • assets/references/linux.md
  • assets/references/random-words.md

Shortcode

Use the references shortcode at the end of the page. The shortcode will check for any references within the document and find the matching citation from the assets directory. The shortcode will create an h2 heading and list all used references.

{{% references %}}
{{% /references %}}

Additional page-specific references should be included within the shortcode so they show up below the heading, alongside the references pulled from the assets directory.

The following shortcode is what this page uses to render its references. Only [^wikipedia-linux] is actually cited on this page, all others (2 3 4 5 6 7 8) are pulled from assets/references/shock.md.

{{% references %}}
[^wikipedia-linux]: Wikipedia. "[Linux](https://wikipedia.org/wiki/Linux)." 2025.
{{% /references %}}

References

  1. Wikipedia. “Linux.” 2025. ↩︎

  2. The Bootstrap Team. “Bootstrap GitHub.” 2025. ↩︎

  3. Alec Thomas. “Chroma GitHub.” 2025. ↩︎

  4. The Hugo Authors. “Hugo GitHub.” 2025. ↩︎

  5. Lucide Contributors & Cole Bemis. “Lucide GitHub.” 2025. ↩︎

  6. Andrey Sitnik. “PostCSS GitHub.” 2025. ↩︎

  7. Full Human. “PurgeCSS GitHub.” 2025. ↩︎

  8. Simple Icons Contributors. “Simple Icons GitHub.” 2025. ↩︎