Closed anthonyfok closed 1 year ago
nickoe
commented
9 years ago I just tested with the example website that is available somewhere I don't exactly rember now. The one used in the hugo introduction documentation. To reproduce, just uninstall asciidoctor from your system. You will see that for example the posts has no body text.
So the important thing is to make hugo use asciidoc, which I did bu uninstalling asciidoctor. You should be able to reproduce that easily.
ingorichter
commented
8 years ago I had the same issue, when I tried to use asciidoc for my blog. I couldn't get it to work, since asciidoctor wasn't installed on my machine and the fallback asciidoc, produced an error.
Perhaps it might already be helpful to give a better error message in the case that asciidoc or asciidoctor has issues processing the content. That would have helped me for sure.
I could make the change and provide a PR for that.
jzacsh
commented
8 years ago (btw, @anthonyfok thanks for implementing asciidoc support :)
tl;dr I think it's known that asciidoc and asciidoctor are slightly different (ie: aside from hugo, i've also experienced that each have errors where the other does not) - the hugo bug is that the error seems to be swallowed[1]
Below I'm just injecting some debug printlns to see exactly what's given to asciidoc stdin, then manually copy/pasting the output so that I can run asciidoc myself. You can see asciidoc outputs an error message when I run it myself, and this is never shown by hugo[1]. How hugo swallows the error message, I'm unsure - I have to run right now, otherwise I'd look into what the jww package is, and try to fix it...
hugo version
Hugo Static Site Generator v0.17-DEV BuildDate: 2016-07-22T17:02:12-04:00
asciidoc: 8.6.9git clone https://github.com/jzacsh/jzacsh-www
and checkout my hugo site exactly as I'm seeing it now while running the below
steps, at b4b9f75cf348So I made the following changes to https://github.com/spf13/hugo/blob/91b61b976d8d/helpers/content.go#L472-L479
$ vi $GOPATH/src/github.com/spf13/hugo/helpers/content.go +:478
# make below changes...diff --git a/helpers/content.go b/helpers/content.go
index e955b00..d5ba2ec 100644
--- a/helpers/content.go
+++ b/helpers/content.go
@@ -475,6 +475,9 @@ func getAsciidocContent(content []byte) []byte {
var out bytes.Buffer
cmd.Stdout = &out
if err := cmd.Run(); err != nil {
+ jww.ERROR.Println("START dumping stdin what was passed to ", path)
+ jww.ERROR.Println(string(cleanContent[:len(cleanContent)]))
+ jww.ERROR.Println("END finished dumping stdin passed to ", path)
jww.ERROR.Println(err)
}Running hugo -v with said diff:
$ go install github.com/spf13/hugo && hugo -v
INFO: 2016/07/22 17:01:30 hugo.go:467: Using config file: /home/jzacsh/media/src/jzacsh-www/config.toml
... snipped ...
Started building site
INFO: 2016/07/22 17:01:30 content.go:472: Rendering with /usr/bin/asciidoc ...
INFO: 2016/07/22 17:01:30 content.go:472: Rendering with /usr/bin/asciidoc ...
ERROR: 2016/07/22 17:01:31 content.go:478: START dumping stdin what was passed to /usr/bin/asciidoc
ERROR: 2016/07/22 17:01:31 content.go:479: :inkscape: https://inkscape.org
:nerdsvg: https://content.j.zac.sh/art/20100519_001_nerd-friend.svg
:burrito: https://content.j.zac.sh/art/burrito-riding-bicycle.jpg
Below are some scanned drawings from a time when I filled multiple new pages
per-day in a sketchbook. Some drawings here _may_ also be vector drawings,
created in {inkscape}[inkscape] with a wacom bamboo tablet ({nerdsvg}[eg "nerd
friend"]).
Lastly, I've started doodling a bit on the go, in a https://doodle.j.zac.sh[**doodle**
mobile-app I created] ({burrito}[eg "burrito riding bicycle"]).
== What's Shown Here
Work shown below is a randomly loaded subset of my scanned work _(until I find
time to create something nice small screens)_. In the meantime, feel free to
link:art-index.html[checkout the full listing] of what's scanned.
{-{-HUGOSHORTCODE-1-}-}
ERROR: 2016/07/22 17:01:31 content.go:480: END finished dumping stdin passed to /usr/bin/asciidoc
ERROR: 2016/07/22 17:01:31 content.go:481: exit status 1
ERROR: 2016/07/22 17:01:31 content.go:478: START dumping stdin what was passed to /usr/bin/asciidoc
ERROR: 2016/07/22 17:01:31 content.go:479: {-{-HUGOSHORTCODE-1-}-}
ERROR: 2016/07/22 17:01:31 content.go:480: END finished dumping stdin passed to /usr/bin/asciidoc
ERROR: 2016/07/22 17:01:31 content.go:481: exit status 1
... snipped ...
0 draft content
0 future content
0 expired content
2 pages created
0 non-page files copied
0 paginator pages created
0 categories created
0 tags created
in 257 msCopy pasted the above ^ debug output into ./foo.adoc
:inkscape: https://inkscape.org
:nerdsvg: https://content.j.zac.sh/art/20100519_001_nerd-friend.svg
:burrito: https://content.j.zac.sh/art/burrito-riding-bicycle.jpg
Below are some scanned drawings from a time when I filled multiple new pages
per-day in a sketchbook. Some drawings here _may_ also be vector drawings,
created in {inkscape}[inkscape] with a wacom bamboo tablet ({nerdsvg}[eg "nerd
friend"]).
Lastly, I've started doodling a bit on the go, in a https://doodle.j.zac.sh[**doodle**
mobile-app I created] ({burrito}[eg "burrito riding bicycle"]).
== What's Shown Here
Work shown below is a randomly loaded subset of my scanned work _(until I find
time to create something nice small screens)_. In the meantime, feel free to
link:art-index.html[checkout the full listing] of what's scanned.
{-{-HUGOSHORTCODE-1-}-}BUG: You can see there's a clear error message about "safe mode":
$ asciidoc --no-header-footer --safe - < foo.adoc
asciidoc: ERROR: <stdin>: line 4: unsafe: ifeval invalid
asciidoc: FAILED: <stdin>: line 4: ifeval invalid safe documentFWIW, without safe mode, I see no errors:
$ asciidoc --no-header-footer - < foo.adoc
<div class="paragraph"><p>Below are some scanned drawings from a time when I filled multiple new pages
per-day in a sketchbook. Some drawings here <em>may</em> also be vector drawings,
created in <a href="https://inkscape.org">inkscape</a> with a wacom bamboo tablet (<a href="https://content.j.zac.sh/art/20100519_001_nerd-friend.svg">eg "nerd
friend"</a>).</p></div>
<div class="paragraph"><p>Lastly, I’ve started doodling a bit on the go, in a <a href="https://doodle.j.zac.sh"><strong>doodle</strong>
mobile-app I created</a> (<a href="https://content.j.zac.sh/art/burrito-riding-bicycle.jpg">eg "burrito riding bicycle"</a>).</p></div>
<div class="sect1">
<h2 id="_what_8217_s_shown_here">What’s Shown Here</h2>
<div class="sectionbody">
<div class="paragraph"><p>Work shown below is a randomly loaded subset of my scanned work <em>(until I find
time to create something nice small screens)</em>. In the meantime, feel free to
<a href="art-index.html">checkout the full listing</a> of what’s scanned.</p></div>
<div class="paragraph"><p>{-{-HUGOSHORTCODE-1-}-}</p></div>
</div>
</div>[1] demonstration showing hugo -v doesn't pass the full error message onto user (right after Started building site there should be one more ERROR line - see above debugging for more):
$ hugo -v
INFO: 2016/07/22 16:42:26 hugo.go:467: Using config file:
...snipped...
Started building site
INFO: 2016/07/22 16:42:26 content.go:472: Rendering with /usr/bin/asciidoc ...
INFO: 2016/07/22 16:42:26 content.go:472: Rendering with /usr/bin/asciidoc ...
ERROR: 2016/07/22 16:42:26 content.go:478: exit status 1
ERROR: 2016/07/22 16:42:26 content.go:478: exit status 1
... snipped ...
0 draft content
0 future content
0 expired content
2 pages created
0 non-page files copied
0 paginator pages created
0 tags created
0 categories created
in 204 ms(Note: I went to the trouble of trying to figure it out, because I kind of prefer asciidoc over asciidoctor)
essen
commented
8 years ago Currently I modify asciidoc to remove the if safe() condition and the exception thrown when it's in safe mode. I don't really need -safe personally, but I didn't see where I could configure hugo to stop using it.
bep
commented
7 years ago This issue has been automatically marked as stale because it has not been commented on for at least four months.
The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still valuable, please open a proposal at https://discuss.gohugo.io/.
This issue will automatically be closed in four months if no further activity occurs. Thank you for all your contributions.
bep
commented
7 years ago Note/Update: This issue is marked as stale, and I may have said something earlier about "opening a thread on the discussion forum". Please don't.
If this is a bug and you can still reproduce this error on the latest release or the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
dobesv
commented
7 years ago I think it would be good to remove the "--safe" option when running asciidoc, because asciidoc cannot generate html in safe mode.
anthonyfok
commented
5 years ago See also https://bugs.debian.org/907478 Bug#907478: hugo: FTBFS if asciidoc is installed but not asciidoctor
To decide: whether to remove the --safe option when running asciidoc, or to remove asciidoc (Python 2 implementation) support altogether and support solely asciidoctor.
Links about asciidoc's obsolescence in the near future:
NOTE: This implementation is written in Python 2, which EOLs in Jan 2020. AsciiDoc development is being continued under @asciidoctor. http://asciidoc.org/
RMStoica-zivver
commented
5 years ago https://github.com/gohugoio/hugo/issues/1437#issuecomment-243086241 has a great point in that the parameters being passed to external helpers should be chosen by the user, as opposed to hardcoded.
For a bit of context: I'm trying to use .adoc files with hugo, and passing the --safe option to either asciidoc or asciidoctor makes them ignore the include:: directive.
for more context, others are reduced to ugly hacks such as: http://ratfactor.com/hugo-adoc-html5s/
anoff
commented
5 years ago I would support more customization options for the external helpers. How about the option to define the filetype & corresponding sys call incl. parameters entirely via the CLI?
e.g. hugo --ext "adoc=asciidoctor -r asciidoctor-diagram" to also include the diagram or other libraries
jmooring
commented
1 year ago The ability to call the asciidoc executable was removed in https://github.com/gohugoio/hugo/pull/7281. You must install the asciidoctor executable.
Closing.
github-actions[bot]
commented
1 year 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.
As @nickoe reported in Issue #470:
2015-06-25:
2015-07-06:
2015-09-16, at the closing of #470:
Currently (Hugo v0.14 and v0.15-DEV as of today) Hugo first tries to call
asciidoctor, and if that fails, triesasciidoc, i.e.asciidoctoris preferred.@nickoe, if it is not too much trouble for you, could you please post an example where Hugo works with
asciidoctorbut fails withasciidoc? That way, we can decide if we can tweak the command-line options we use to callasciidoc, or whether to dropasciidocaltogether and useasciidoctorall the time.Many thanks for your help!