Community support for Antora, the static site generator for making documentation sites based on AsciiDoc.
there are some warnings about missing attributes, but those never caused a local build to fail.
It's just barely possible that that would explain the timeout, IIRC it can cause a 3-4X slowdown.
Which node version do you have locally?
even 5-10 minutes seems pretty slow.... I don't recall your site being gigantic?
btw, I just built locally again and it took 12 minutes. It's not a gigantic site, but there are some files that have many lines (listings of zip codes, counties, etc of different countries). Example, one single file that lists all counties in the united states has over 3000 lines in it alone. And we have files with similar lists for other countries. I noticed when I added those files, that the time it to Antora to build increased significantly.
@ronipolus_gitlab I've updated the README documentation for antora-pdf and the pdf-ui at https://gitlab.com/djencks/antora-pdf. I don't have any code changes so I'm not ready to create a new version. Let me know if it makes more sense now :-)
@mark-plummer Ah, I remember one of those pages! In that case if you are building with node 10 locally the use of node 12 at netlify would likely explain the timeout.
I could try removing those from the site and try again, but I'm hoping to find a way to be able to list them on our new Antora site. Here's an example from our old site: https://docs.thoughtspot.com/latest/reference/geomap-reference.html I'm planning to use your tabs instead of the DL triangle thing.
the problem only occurs when your content is in the same repo as your playbook, and you use more branches than the one the playbook is on.
You can also use a remote git url for the non-playbook branches in the playbook. Then Antora will fetch those properly without assuming anything about the local checkout.
here we go... this is from the docs.asciidoctor.org netlify.toml...
[build.environment]
CI = "true"
NODE_VERSION = "10"
# WARNING netlify-build ignores NPM_FLAGS when installing plugins, so use low-level NPM_CONFIG_ flag instead
#NPM_FLAGS = "--no-optional"
NPM_CONFIG_OPTIONAL = "false"
ANTORA_CACHE_DIR = "node_modules/.cache/antora"
If you have anything like that try specifying at least NODE_VERSION = "10"
the repo that's in is https://github.com/asciidoctor/docs.asciidoctor.org
I'm also thinking I need to do something to reduce the impact those files that have thousands of lines in them on build time. Any tips on how I could reduce the impact those? Would it reduce build time, to have those lists as html inside passthrough blocks?
I think (but I'm not sure) that passthrough content gets split up into an array of lines, so it's very possible that passthrough would have the same problem. If node 10 doesn't build fast enough, you could try it.
One thing I'm curious about for the asciidoctor site, is how you get it to point to "latest", like here: https://docs.asciidoctor.org/asciidoctor/latest/install/supported-platforms/. We do this on our current doc site: https://docs.thoughtspot.com/latest/reference/geomap-reference.html. Can you tell me how I could do that?
I’m not sure what you’re asking but suspect it has to do with antora/antora#314. Look in the asciidoctor docs playbook to see how it’s configured.
thanks. bascially, the goal is to have the url always have "latest" in it and have it point to the latest version branch. This way, when someone bookmarks a page on the site, it will always take them to the latest, whether the latest. I did notice this in your site playbook:
latest_version_segment_strategy: redirect:to
latest_version_segment: latestThat got me thinking there must be some setting/attribute somewhere that can elegantly control that.
Mark: those are the available attributes for controlling this feature.
but if you say it works, it's fine there error is likely elswhere
sorry to interject
Hello, I would like to use asciidoctor-bibtex extension in antora. As far as I understand from the documentation at https://docs.antora.org/antora/2.2/playbook/configure-asciidoc, I need an npm module version of asciidoctor-bibtex ruby gem. I have not been able to find one. Is there a easy way to to use this module in antora. Any help much appreciated. (I am not familiar with JavaScript and npm modules etc.,just basic install and use)
@benibilme_gitlab This is probably a non-trivial undertaking. There are some Ruby dependencies that I'd at least start by translating using Opal, see https://docs.asciidoctor.org/asciidoctor.js/latest/extend/extensions/compile-ruby-extension/. I guess I'd start by trying to translate the extension also and see what happens. Rewriting the extension itself in javascript while time-consuming probably wouldn't be that hard (at least for me...). However....
In addition, my understanding of the Ruby extension is that it works on one page. I'd expect that for Antora you'd want a single bibliography for a component-version. Therefore there'd be more work. I expect you'd need the ability to process the page the bibliography appears on last, which requires a pipeline extension or modification so that the pages can be sorted.
I've never used the Opal compiler, so I might get interested in this to try it out.
Can you go into more detail about how you want to use this, in particular the scope of each bibliography?
In addition, my understanding of the Ruby extension is that it works on one page. I'd expect that for Antora you'd want a single bibliography for a component-version. Therefore there'd be more work. I expect you'd need the ability to process the page the bibliography appears on last, which requires a pipeline extension or modification so that the pages can be sorted.
I've never used the Opal compiler, so I might get interested in this to try it out.
Can you go into more detail about how you want to use this, in particular the scope of each bibliography?
8 replies
@benibilme_twitter out of curiosity, did you try https://github.com/riboseinc/asciidoctor-bibliography? If so, what do you think of it and/or why do you use asciidoctor-bibtex? Please note that both libraries are written in Ruby so they won't work as-is in Antora but I want to learn more about them (what are the pros and cons)