permalinks-copy-images

permalinks-copy-images

This recipe follows a quite useful - though uncommon - pattern how to store content on GitHub and then use it to create static pages:

Let's assume you have the following structure on GitHub:

|── content
    |── article-1
        |── images
            | screenshot.png
            | another-image.png
        | README.md
    |── article-2
        |── images
            | screenshot.png
            | another-image.png
        | README.md

This pattern has some benefits:

• You can send out a link to just the folder and the README.md will always be shown as the default content
• You can reference the images relatively and they will be shown always be shown correctly
• When using hundreds of articles using assembly, you do not run into the risk that you mix-up image names
• The images are always related to its articles, therefore it's easy to move around content

Using now assemble-permalinks in combination with a postWrite middleware copies all files to the generated permalink-folder:

|── articles
    |── article-1-permalink
        |── images
            | screenshot.png
            | another-image.png
        | index.html
    |── article-2-permalink
        |── images
            | screenshot.png
            | another-image.png
        | index.html