Skip to content

Instantly share code, notes, and snippets.

View szkiba's full-sized avatar

Iván Szkiba szkiba

View GitHub Profile
@szkiba
szkiba / testable-markdown-code-blocks.md
Last active January 9, 2024 18:01
Testable Markdown Code Blocks

Testable Markdown Code Blocks

There is no worse developer experience than bad example code in the documentation.

It is easy to make mistakes in code slightly more complicated than a Hello World program. In fact, in Hello World as well.

How can you avoid it?

It is advisable to test the example codes in the documentation, like all code. Since the example codes also change over time, this testing should be done automatically, built into the documentation release process.

openpgp4fpr:35816E184F2BB34C2756B9916D225475255F7AF9

{
"basics": {
"name": "Iván Szkiba",
"picture": "https://avatars3.githubusercontent.com/u/16244553?v=4",
"label": "System Architect @NNG",
"headline": "Becoming (a good) programmer is an endless adventure",
"summary": "I'm a software architect with hands on programming knowledge. I eager to keep my knowledge up to date, follow new technologies, software development methodologies, practice and promote them in my daily work. ",
"website": "https://szkiba.github.io",
"blog": null,
"yearsOfExperience": 20,
@szkiba
szkiba / keybase.md
Last active February 26, 2019 20:43
keybase.md

Keybase proof

I hereby claim:

  • I am szkiba on github.
  • I am szkiba (https://keybase.io/szkiba) on keybase.
  • I have a public key ASBYnylDgigAsFHRQWLtJThxZv4xcOXai8YiMaPDYzovngo

To claim this, I am signing this object: