[RFC] Additional metadata for readme examples?

Might be helpful to link out to the code in readme examples. Links would use a tag or sha to avoid taking the user to the latest changes.

• Update: This might introduce a lot of maintenance though, and I am not sure about it.

server.router.get(String, RouteHandler<ServerRequest, Toolkit>)

// Javascript Example
server.router.get('/', (request, { file }) => {
    return file('./foo.jpg');
});

// Typescript Example
server.router.get('/', (request : ServerRequest, { file } : Toolkit) => {
    return file('./foo.jpg');
});

[sholladay]

Looks like my theory about 3 was correct. I did a little experiment in PR #48 and changed a few of the code fences in the documentation to use “ts” instead of “js”. Now the code in those examples is clickable, presumably because it matches the language of the source code.

For example, this one: https://github.com/sholladay/pogo/tree/001d8099157d3a54b542712c2371aab1d768c595#using-hdirectory-recommended

[sholladay]

I added TSDoc comments to further improve the deno doc output in commit https://github.com/sholladay/pogo/commit/8fa9c0c77be12cffc8a52cc8f51ad50c13366ab4. I also updated the language of the code examples in the documentation to enable GitHub’s link-to-definition feature in commit https://github.com/sholladay/pogo/commit/4d24945730f5c4892bed90103be625e6189dd5d3.

With your PR, plus those changes, I think we can probably close this issue. What do you think?

I’m open to any other suggestions for improving the documentation. The next logical step I can think of would be to have a website for the docs.