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

Externalize Hugo Code Examples #37

Open
tajmone opened this issue Nov 24, 2019 · 0 comments
Open

Externalize Hugo Code Examples #37

tajmone opened this issue Nov 24, 2019 · 0 comments
Labels
💡 enhancement A new feature or enhancement request 🔨 Asciidoctor Tool: Asciidoctor ⭐ assets Topic: Hugo Book assets ⚠️ useful Priority: Low
Projects
Milestone

Comments

@tajmone
Copy link
Owner

tajmone commented Nov 24, 2019

The upcoming Asciidoctor v2.0.11 release will introduce a new feature allowing to include:: external files in encodings other than UTF-8 (see asciidoctor/asciidoctor#3248 and mojavelinux/asciidoctor@4c008b00).

When this release is out, we could externalize some code examples to actual Hugo source files — especially the exercises in the various What Should I Be Able to Do Now? sections, as well as Hugo Library snippets and long examples. Of course, that is if these code blocks don't contain extra AsciiDoc elements (footnotes, call-outs, etc.).

This could also allow the project to actually test the source files against Hugo compiler, and even automatically produce their output transcripts (i.e. via a CLI Hugo terp that can accept solution files and generate transcript logs).

These changes would also simplify future maintenance of the book, especially so if the Hugo Library is further developed, for by including its snippets directly from the library source would grant that the Hugo Book always mirrors the latest version of the Hugo Lib.

For more info see:

@tajmone tajmone added 💡 enhancement A new feature or enhancement request ⚠️ useful Priority: Low 🔨 Asciidoctor Tool: Asciidoctor ⭐ assets Topic: Hugo Book assets labels Nov 24, 2019
@tajmone tajmone added this to the plus ultra milestone Nov 24, 2019
@tajmone tajmone added this to To do in Long Term via automation Nov 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 enhancement A new feature or enhancement request 🔨 Asciidoctor Tool: Asciidoctor ⭐ assets Topic: Hugo Book assets ⚠️ useful Priority: Low
Projects
Long Term
  
To do
Development

No branches or pull requests

1 participant