search

Azure / simdem

Tool for Simulating Demo's, delivering Tutorials and using documentation as tests.
MIT License
34 stars 17 forks source link

Allow the use of code blocks that are not executed #101

Open SorraTheOrc opened 6 years ago

SorraTheOrc commented 6 years ago

Sometimes it is useful to have a code block in a document that is not intended to be executed. For example, we might want to provide a snippet of code that illustrates how something works. This might be enabled with a flag in the code block language definition.

I've not looked for a suitable syntax for this but something like Java, execute=false would suffice.

lastcoolnameleft commented 6 years ago

This makes sense. Although it opens up a bigger question around syntax for the code block header (in Markdown, the code language string).

A few options:

SorraTheOrc commented 6 years ago

Actually I realized this is a noop, at least in initial implementations. We can simply use indentation for non-executable code blocks.

SorraTheOrc commented 6 years ago

As for the format of the language string in future versions. This is going to be dictated by what markdown parts can work with.

lastcoolnameleft commented 6 years ago

Can we close this since we'll use indentation instead for code blocks?

SorraTheOrc commented 6 years ago

Let's leave it open but low price. I'd prefer something that just works. But it is not a blocker.

Get Outlook for Androidhttps://aka.ms/ghei36

From: Tommy Falgout notifications@github.com Sent: Sunday, March 4, 2018 12:19:46 PM To: Azure/simdem Cc: Ross Gardler; Author Subject: Re: [Azure/simdem] Allow the use of code blocks that are not executed (#101)

Can we close this since we'll use indentation instead for code blocks?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fsimdem%2Fissues%2F101%23issuecomment-370260406&data=04%7C01%7Cross.gardler%40microsoft.com%7C5ce41107cdfa4ce2aa0e08d5820d46c1%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636557915888745063%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwifQ%3D%3D%7C-2&sdata=HahK%2Fgzxk%2BBCAmaGrvU9HF%2FSciVLfvPuXy3pkgxLsjM%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAPRgBlZtyosGv7OL4D14rE5KRp0BWLxks5tbExigaJpZM4SUJUj&data=04%7C01%7Cross.gardler%40microsoft.com%7C5ce41107cdfa4ce2aa0e08d5820d46c1%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636557915888745063%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwifQ%3D%3D%7C-2&sdata=khJEuN8UNiD5LvexCSCBSZEETQc6a0xMYK8o0nEncVQ%3D&reserved=0.