search

ponylang / pony-tutorial

:horse: Tutorial for the Pony programming language
http://tutorial.ponylang.io
BSD 2-Clause "Simplified" License
310 stars 111 forks source link

[5/?] Add ability to run code examples in the playground: Run code samples inline #543

Closed shaedrich closed 3 months ago

shaedrich commented 4 months ago

See https://github.com/ponylang/pony-tutorial/issues/340

As discussed in #205

[!WARNING] Will only work, after #544 and #542 have been merged. Works in combination with https://github.com/ponylang/pony-playground/pull/212. Contains changes from #544 until db1eb1183d0746535db719cd537ad8c00a9cc1d1

shaedrich commented 4 months ago

2024-04-30 22:41:26 [ERROR ] Found errors in [markdownlint] linter! 2024-04-30 22:41:26 [ERROR ] [/github/workspace/docs/getting-started/hello-world.md:23:1 MD042/no-empty-links No empty links [Context: "[:fontawesome-solid-play: Run ..."]] 2024-04-30 22:41:26 [ERROR ] Linter CMD:[markdownlint -c /github/workspace/.github/linters/.markdown-lint.yml /github/workspace/docs/getting-started/hello-world.md]

If that really is a problem, should I replace this with an HTML button?

> Processing: docs/getting-started/hello-world.md Misspelled words: \ docs/getting-started/hello-world.md: html>body>p -------------------------------------------------------------------------------- fontawesome --------------------------------------------------------------------------------

This is an icon. This should not be spellchecked.

SeanTAllen commented 4 months ago

You can update the spelling list to add fontawesome to the list.

SeanTAllen commented 4 months ago

2024-04-30 22:41:26 [ERROR ] Found errors in [markdownlint] linter! 2024-04-30 22:41:26 [ERROR ] [/github/workspace/docs/getting-started/hello-world.md:23:1 MD042/no-empty-links No empty links [Context: "[:fontawesome-solid-play: Run ..."]] 2024-04-30 22:41:26 [ERROR ] Linter CMD:[markdownlint -c /github/workspace/.github/linters/.markdown-lint.yml /github/workspace/docs/getting-started/hello-world.md]

If that really is a problem, should I replace this with an HTML button?

I'd want to see what this does in terms of our htmlproofer that makes sure all the links are valid. This might blow that up. Not sure. We'd need to address that one way or another if it is an issue.

I can see locally the proofer is fine. In the markdownlint ignore, go ahead and add MD042 as an ignored rule.

netlify[bot] commented 4 months ago

Deploy request for pony-tutorial pending review.

Visit the deploys page to approve it

Name Link
Latest commit 0bc061c23245be3c90019d07a655b1ac55d56f52
shaedrich commented 3 months ago

Closed in favor of #554 (not a fork)