Skip to content

Conversation

@briandominick
Copy link
Collaborator

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.

  • Default dirs list (@includes_dirs_def) can be overridden by:
    • Using --includes_dirs option with path arguments
    • Adding includes_dirs: property to a build block of a parsing action
  • Local base directory is inferred from primary template's path.

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
      

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

* Default dirs list (@includes_dirs_def) can be overridden by:
** Using --includes_dirs option with path arguments
** Adding includes_dirs: property to a build block of a parsing action
@netlify
Copy link

netlify bot commented Jan 24, 2022

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

🔨 Explore the source changes: 8f1e722

🔍 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
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants