Have ideas to improve npm?Join in the discussion! »

    asciidoctor-chunker

    1.0.2 • Public • Published

    asciidoctor-chunker

    npm version Node.js CI License: MIT

    Generates chunked (multi-page) HTML from Asciidoctor's single HTML file with the support of fine-tuned splits by chapters, sections, or any depth of subsections. Here is the sample output. Each chapter can have different levels of extraction depth. See What it does for details.

    News

    • 2021/5/9 Ver 1.0.2 The toc item for the titlepage can be configured with --titlePage option (thanks to @johnthad).
    • 2021/3/17 Ver 1.0.1 The script contains shebang and can be invoked directly. Published on npm. You can install via npm. See Installation.
    • 2021/2/27 Ver 1.0.0 Released!
      • Non opinionated page navigation at the bottom of each page is available.
      • You can insert custom css from the command line with --css option.
      • If you have any custom elements inserted in the source html, they are handled in non-strict mode by setting --no-strictMode option.
      • Gives warning if no relative links are available in tocs.
      • The current page toc is highlighted and scrolled into view.
    • 2021/2/20 Ver 0.9 is released! This is a complete re-write from the previous Lisp version. It is re-implemented in JavaScript! So it is super easy to setup with NodeJS! The fine tuned split options are available. Oh, and it runs a lot faster than the previous version!😊
    • 2021/2/10 Started work on the more enhanced version in javascript branch. Please wait a couple of weeks. The new version can control any depth of sections to split. And even more, each chapter can have a different depth extraction level. The new version is written in JavaScript so it will be a lot easier to install!
    • 2018/7/11 Locally linked files with link and script tags with relative paths are copied to the destination directory keeping the structure of the relative path. So the custom CSS and script files should be properly copied by asciidoctor-chunker.

    What it does

    Asciidoctor-Chunker generates chunked HTML from a single HTML generated by Asciidoctor.

    1. Splits part preambles and chapters (or any depth of section level) into separate files. Each chapter can be configured to have a different depth for extractions.
    2. Extracts css inside the style element into a separate file so the browser can cache and share it among all the pages.
    3. Places footnotes in the file they belong to. This also means that the multiply referred footnotes are placed in every referrer's files and sets the link back to the referrer's id within the page.
    4. Re-writes the relative links in order to point to the appropriate chunked files.
    5. Copies the local images and linked files (with link, script and img tags) whose paths are relative, to the directory relative to the chunked html output. Files are only copied if they are new or modified compared to the previously copied one.
    6. Adds a titlepage link in the toc and page navigation at the bottom of each page.
    7. Adds non-opinionated page navigation.
    8. Highlights the current page toc items and they get scrolled into the viewport.

    Here is the sample output created from the Asciidoctor User Manual. The footer on the sample page is added by setting the asciidoctor attribute and is not added by asciidoctor-chunker.

    Installation

    Asciidoctor-Chunker is written in JavaScript and runs with NodeJS.

    1. Install Node.js, the JavaScript runtime. This will install npm, the package manager CLI for Node.js.
    2. If you want to install globally, invoke the following;
      npm install -g asciidoctor-chunker
      
      You can install locally under the current directory as;
      npm install asciidoctor-chunker
      
    3. Or alternatively you can download the pre-built program from the release.

    Usage

    If you installed globally:

    asiidoctor-chunker [single-html-file] -o [output-directory]
    

    If you installed locally invoke the following under the directory you installed:

    npx asciidoctor-chunker [single-html-file] -o [output-directory]
    

    If you installed the prebuild program simply run the script as:

    ./asciidoctor-chunker.js [single-html-file] -o [output-directory]
    

    [single-html-file] is the single HTML file generated by Asciidoctor from the book doctype. If the output directory is not specified, the default is html_chunks under the current directory.

    More discription of usage is available with --help option.

    How to Configure the Depth of Extraction

    You can list the multiple settings by connecting each specifier with a comma. Each specifier is consisted of either a single number or a collon separated with two numbers.

    The single number sets the default level of extraction. Number 1 is the application's default and it extracts the chapter level. Number 2 for section extraction, 3 for subsection, and so on to 6 which is the maximum section level of Asciidoctor.

    The list of collon separated numbers, chap:level, can change the extraction depth for specific chapters, so 3:2 means chapter 3 is extracted down to 2 levels (ie. section level). You can use a hyphen to specify the range of chapters to set as chapFrom-chapTo:level, so 1-3:5 means chapter 1 through 5 should be extracted with the depth level 5.

    Example:

      --depth 2          The default level 2, all the chapters and
                         sections will be extracted.
      --depth 3,1:2,8:5  The default level 3, level 2 for Chap 1,
                         level 5 for Chap 8.
      --depth 1,3-8:2    The default level 1, level 2 for Chap 3 to 8.
      --depth 3-8:3      No default is set so default level is 1, and
                         level 3 for chap3 to 8.`
    

    Custom CSS

    By default asciidoctor-chunker.css is included in the output directory. It provides the non-opinionated page navigation at the bottom of every chunked page. You can override this by giving a comma separated list of paths to your custom css files. They are copied into the output directory so the paths must be accessible by asciidoctor-chunker.

    About Strict Mode

    If you have any custom elements inserted under <div id=#content></div> in the source single html, asciidoctor-chunker ignores it by default. If you want them to be included into the chunked html, set the option --no-strictMode. The element will be copied to every chunked page.

    Customizing Titlepage

    The index.html created by asciidoctor-chunker is selected by clicking the word Titlepage in the table of contents. To change the default value, use the option --titlePage [string] where [string] is the desired text.

    Example

    The project contains the example directory where you can generate the chunked html for the Asciidoctor User Manual by invoking make. Simply go into the example directory and invoke make. This will clone the asciidoctor project from the github for the first time, then the chunked html will be generated under test/output-chunk/html_chunk/ directory. The index.html is the first page.

    $ cd example
    $ make
    

    License

    MIT

    Developer's Memo

    • Unit test uses test/resources/output/single/sample.html generated from test/resources/sample.adoc.
    • npm install cheerio commander
    • npm install --save-dev ava webpack webpack-cli webpack-shebang-plugin

    Install

    npm i asciidoctor-chunker

    DownloadsWeekly Downloads

    2

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    510 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar