-
Notifications
You must be signed in to change notification settings - Fork 1
Description
⚠️ IMPORTANT — This must be implemented after Issue #72 is fixed.
- Add a script to create a Zip archive of the current Hugo Book for quick distribution and inclusion with tagged releases:
- Add to the Zip archive the following files:
- The HTML version (copy it).
- The required image assets (copy them inside
images/subfolder). - A
README.txtwith a brief presentation (needs to be created). - The
LICENSEfile (copy it). - An ad hoc standalone AsciiDoc version (generate it) which exploits attributes and preprocessor directives to ensure:
-
:toc:is set toleft. -
:imagesdir:points to the customimages/subfolder. - any other required settings are correctly in place.
-
- Name the Zip file
hugo-book-vX.Y.Z-html-asciidoc.zip, wherevX.Y.Zshould be the current version number.- Find a way to make the script aware of the current version of the book.
- Exclude the created Zip archive and any temporary copied/created files from Git tracking.
- Check if the AsciiDoc source is able to find the included images, and/or provide a sample build command with the required options to make it work.
- Add to the Zip archive the following files:
- Document it:
- Main
README.mdfolder contents and project description. - Main
README.mdChangelog.
- Main
When I submitted the first release of the new Hugo Book port to the IF Archive I provided them with a Zip archive (hugo-book-v1.0.0-html-asciidoc.zip) containing the HTML book and the standalone AsciiDoc source:
This is the same Zip archive which I've added as an attachment to the project release:
But I forgot to include the required images for the AsciiDoc version (not a huge deal, since the HTML doc embeds all the images, so they can be easily extract from it by dragging them to a folder).
So I decided that with the next release I would add to the repository a shell script to automate the creation of these Zip archives for quick distribution. Although it's not mandatory that I add this script with the upcoming version, it would be a good time to do so.