Readme Tweaks

[audy]

• update git tag to @v1.0.1 (@v1 was not found)
• remove images_dir in example YAML (I think it's just images_path)

[BaileyJM02]

Hi Austin, thanks for taking the time to do this, unfortunately, the images_dir and images_path are actually two different variables.

• The images_dir is the directory the images are placed in.
• The images_path is the import path for images from within the doc, so if I imported ./images/image.png the image path would be ./images.

However, this has brought up a good point and I'll look into renaming image_path to import_path in the future to ease confusion.

[hhe]

The import_path will always be the location of images_dir relative to input_dir, assuming that the GitHub markdown view is able to show the images which is a reasonable assumption.

[BaileyJM02]

Hi @audy, @hhe, sorry I have just looked over this again, I have been quite busy over the last few months. I'm closing this in favour of #12 as this is the correct fix, which I have only just spotted thanks to that, which is change image_path to image_import. And to expand more on the point Jimmy made, I have two paths in a setup like below where there is a difference due to the way relative imports work, but you were correct in saying logically they are the same path:

with:
  input_dir: .coursework
  output_dir: .coursework
  images_dir: .coursework/images
  image_import: ./images

Due to this I won't be changing it now, but I may add some more logic in a new version to simplify the setup and allow just one variable to be defined.

Thanks to the both of you for your input. 😄