DocOps / liquidoc-gem

The canonical gem source for LiquiDoc, a ruby-based documentation parsing and rendering utility enabling advanced builds with Asciidoctor, Jekyll, Liquid, and semi-structured data files.
https://docs.docops.org/liquidoc-user-manual.html
MIT License
12 stars 5 forks source link

Fix include dirs, release 0.12.1 #95

Open briandominick opened 2 years ago

briandominick commented 2 years ago

This change will bump us to 0.12.1.

This patch enables explicitly designating alternate source paths for includes, and prepends the calling template's own home directory to the list.

This patch has been released as liquidoc v0.12.1.rc1, so testing will be simple:

  1. Change your Gemfile reference to: gem 'liquidoc' , '=0.12.1-rc1'
  2. Update the gem and a couple of others: bundle install
  3. Perform builds with this gem. Use Liquid templates that call other files using the {% include file-name.txt %} format.

    • Try with the included template in an arbitrary path like test/templates/file-name.txt.
    • Designate this path with --includes_dirs test/templates on the CLI.
    • Designate with, ex:
      builds:
      -- output: _build/test-doc.txt
         template: _templates/my-template.txt
         includes_dirs: test/templates
netlify[bot] commented 2 years ago

✔️ Deploy Preview for hungry-almeida-d95259 ready!

🔨 Explore the source changes: 8f1e7221ce3cfc4b0e19f69ed3c6f03ebd241d32

🔍 Inspect the deploy log: https://app.netlify.com/sites/hungry-almeida-d95259/deploys/61ee0805f66c94000891bc86

😎 Browse the preview: https://deploy-preview-95--hungry-almeida-d95259.netlify.app

briandominick commented 2 years ago

New content in user guide -- see the sidebar in this section: https://deploy-preview-95--hungry-almeida-d95259.netlify.app/liquidoc-user-manual.html#_tags