search

gohugoio / hugo

The world’s fastest framework for building websites.
https://gohugo.io
Apache License 2.0
74.63k stars 7.45k forks source link

Hugo Theme with inline documentation #2232

Closed ecarlisle closed 8 years ago

ecarlisle commented 8 years ago

I've been considering creating a HUGO theme that is specifically designed as a teaching tool for HUGO concepts and workflows. I've found that HUGO concepts (archetypes, sections, types, content-views) are challenging to present without concrete examples.

To give a very small approach example, consider the following content in the theme's _default archetype.

+++
# Note: The Page variables "title" and "date" will be automatically added in a content document's 
# frontmatter when the document is created via the "hugo new" command. They do not need 
# to be included in archetypes.

# Note: These keywords can be used for page keyword metadata but may also be used in 
# other taxonomy constructs.
keywords = ["a", "b", "c"]
description = ""
+++

To not duplicate documentation, I would give gohugo.io URLs for deeper explanation.

My big questions:

  1. Has this been done already? If so, how can I help?
  2. What are the feelings on this? Do you think it would be a useful, interactive HUGO primer?
  3. Are there concerns these would raise like "Aren't you duping documentation?"

Thanks!

github-actions[bot] commented 2 years ago

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.