Template for readme.md using screenshots

Template for readme.md using screenshots.md

template-with-images.md

This example organizes all the non-pbix files in subdirectories.
Imagine main is a local folder, ex: inside the root folder: `c:\git\PowerQuery

The absolute path to my screenshot is:

c:\git\PowerQuery\img\title.screenshot.png

The relative path from the readme will be

./img/title.screenshot.png

links

[link title](./pq/title.pq)
[report.pbix](./report.pbix)

Images

![alt text](./img/title.screenshot.png)

Here's what the subdirectories look like:

/main    
    /img
        title.screenshot.png
    /pq
        title.pq
        
    title.pbix
    readme.md

Note: You won't see the image on this screen, because there's no image in this gist. In the real repo, it'll display your image.

References / See More:

• You can link to the latest version ninmonkey/repoName/blob/main/readme.md
• You can link as a permalink ninmonkey/repoName/blob/96fd33ab255ceeccacc6f67048c9d2377ed6e21f/readme.md

If you want to go crazy

I dynamically build toc.md using PowerShell. The top toc.ps.md file is one line, it calls a macro.

Beware, this part is messy. But if you're curious, the file import.ps1 declares the important functions: repo.WriteFileSummary, md.Path.escapeSpace, md.Write.Url

template-with-images.md

Web Requests

Catching Web.Contents Errors using and ManualStatusHandling

links:

title.pq

screenshots:

report.pbix

this shows code with syntax highlighting

try Web.Contents( "https://httpbin.org", [
    RelativePath =  "/status/codes/418",
    ManualStatusHandling = {401, 402, 404} & {405..500}
    ] )
catch (e) =>
    "Error, but we caught it" meta e