I’m writing tutorials for a library in Hugo and find that I am frequently copy/pasting snippets of functional example code into my tutorials. Has anyone thought or otherwise developed a method to include code snippets directly from source files? For example, Doxygen the \snippet command to do something similar to this.
You can use
readFile and write your own shortcode: https://gohugo.io/templates/files/#readfile-example-add-a-project-file-to-content
Indeed. The problem isn’t reading the files, it is extracting snippets from the code. I suppose I could use readFile combined with some regular expression magic to make it happen within a shortcode; however, that’s less than ideal.
For the moment, I’m parsing the files ahead of time with SED and generating snippet files that are included with readFile. I’m hoping the Hugo gurus here might have a different idea than what I’ve described above.
This is how I did it.
tocorresponding to the line numbers
then in the actual shortcode:
splitthe file at line breaks
linesprinting out only the lines between
It did a bunch of other things, but that’s the main bit.
Here’s what I ended up doing:
- I wrote a Python script that recursively reads a source tree and searches for Doxygen-style
\snippettags in the source code. It extracts the snippets to the
data/snippetsdirectory. If an error is found while parsing the snippet, the script errors out. The snippets are named using a
- I wrote a shortcode that takes
Filename SnippetNameas arguments. The shortcode uses
readFileto search for the corresponding snippet. It errors out if the snippet doesn’t exist.
- I wrote an external build script that calls the Python file followed by Hugo.
Although this is far from ideal, it is reasonably extensible if future versions of Hugo would permit more flexible files parsing techniques.