Hi,
I was looking at whether Antora could automatically generate pages when the source change so that previewing while modifying docs would be somewhat easier. (One does not need to re-run ./preview.sh, but ./build.sh must be re-run after each change.)
I'd filed a ticket upstream and was directed to this discussion: https://gitlab.com/antora/antora/issues/329
It seems to be a WIP, and for the moment there's a way to do this. It uses a gulpfile(?) however, and I don't know enough to figure out how to make this work with our workflow. Would someone know?
------
Also, as a hack in the meantime, if you use vim, you can re-run the ./build.sh script each time a buffer is saved using "BufWritePost". So something like this in your .vimrc would work:
augroup fedora_docs autocmd! autocmd BufWritePost *adoc !./build.sh augroup END
There's a caveat, though---you must start vim in the project root where ./build.sh resides. I'm sure there's a way to detect the project root and find ./build.sh and put the output into the quickfix list etc, but I've not gotten down to writing a full plugin yet. :)
Add fugitive to the mix etc., and you don't need to exit vim while editing docs at all: https://github.com/tpope/vim-fugitive
Please feel free to improve on this and share them with everyone. Your friends in the vim documentation are:
: help augroup : help autocmd : help BufWritePost
My rather messy vimrc is here for reference: https://github.com/sanjayankur31/vimfiles/blob/master/vimrc
That's awesome, thanks for that!
Regarding the gulpfile: Gulp is some kind of JS toolkit for task automation: https://gulpjs.com/
When we talked on IRC about this I mentioned you can do a live preview of the UI, that uses Gulp as well: https://docs.antora.org/antora-ui-default/build-preview-ui/#build-continuous... - unfortunately that's about all I know about it, I have no idea how it actually works, I just remembered seeing it in the UI docs.
On 8/29/19 11:58 AM, Ankur Sinha wrote:
Hi,
I was looking at whether Antora could automatically generate pages when the source change so that previewing while modifying docs would be somewhat easier. (One does not need to re-run ./preview.sh, but ./build.sh must be re-run after each change.)
I'd filed a ticket upstream and was directed to this discussion: https://gitlab.com/antora/antora/issues/329
It seems to be a WIP, and for the moment there's a way to do this. It uses a gulpfile(?) however, and I don't know enough to figure out how to make this work with our workflow. Would someone know?
Also, as a hack in the meantime, if you use vim, you can re-run the ./build.sh script each time a buffer is saved using "BufWritePost". So something like this in your .vimrc would work:
augroup fedora_docs autocmd! autocmd BufWritePost *adoc !./build.sh augroup END
There's a caveat, though---you must start vim in the project root where ./build.sh resides. I'm sure there's a way to detect the project root and find ./build.sh and put the output into the quickfix list etc, but I've not gotten down to writing a full plugin yet. :)
Add fugitive to the mix etc., and you don't need to exit vim while editing docs at all: https://github.com/tpope/vim-fugitive
Please feel free to improve on this and share them with everyone. Your friends in the vim documentation are:
: help augroup : help autocmd : help BufWritePost
My rather messy vimrc is here for reference: https://github.com/sanjayankur31/vimfiles/blob/master/vimrc
docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org
Ankur,
This is great. Would you mind writing that up as a Community Blog post? I bet there are other folks in Fedora using Antora that aren't on the docs like who would find it useful.
On Thu, Aug 29, 2019 08:31:24 -0400, Ben Cotton wrote:
Ankur,
This is great. Would you mind writing that up as a Community Blog post? I bet there are other folks in Fedora using Antora that aren't on the docs like who would find it useful.
Sorry---been busy with other things.
If folks think it's mature enough, sure. I'll make time to write a short one up next week.
-
Ankur Sinha -
Ben Cotton -
Petr Bokoc