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

shaedrich · 2024-04-30T14:01:36Z

As discussed in #205

Warning

Will only work, after #544 and #542 have been merged. Works in combination with ponylang/pony-playground#212. Contains changes from #544 until db1eb11

to mark array entry as object rather than a string

…drich/pony-tutorial into code-samples-separate-files

… Capabilities" directory

…es" directory

…g" directory

…s" directory

… directory

…sions" directory

…nce Capabilities" directory

…cs" directory

… directory

…ices" directory

and display result below

and fetch snippet from raw git

shaedrich · 2024-05-01T06:10:40Z

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:
<htmlcontent> docs/getting-started/hello-world.md: html>body>p
--------------------------------------------------------------------------------
fontawesome
--------------------------------------------------------------------------------

This is an icon. This should not be spellchecked.

SeanTAllen · 2024-05-14T18:18:57Z

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

SeanTAllen · 2024-05-14T18:22:25Z

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.

Co-authored-by: SeanTAllen <[email protected]> As suggested in ponylang#543 (comment)

netlify · 2024-05-14T18:22:53Z

👷 Deploy request for pony-tutorial pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`0bc061c`

Co-authored-by: Sean T. Allen <[email protected]> As suggested in ponylang#543 (comment)

Co-authored-by: Joe Eli McIlvain <[email protected]> As requested in ponylang#544 (comment) From db1eb11

Co-authored-by: Joe Eli McIlvain <[email protected]> As requested in ponylang#544 (comment) From db1eb11 Follow-up to 3339fd2

shaedrich · 2024-06-05T14:36:45Z

Closed in favor of #554 (not a fork)

shaedrich and others added 29 commits April 21, 2024 05:35

feat(config): Activate mkdocs snippets extension

765384b

refactor(code-samples): Turn code samples into snippets

c1a8a22

fix(config): Add missing colon

58e6599

to mark array entry as object rather than a string

feat(config): Enable check_paths option for snippets

62a001d

fix(code-samples): ✏️ Fix snippet file embed path

c6b9959

Merge branch 'code-samples-separate-files' of https://github.com/shae…

dc86c15

…drich/pony-tutorial into code-samples-separate-files

refactor(code-samples): 📝 Turn code samples into snippets for "Object…

70dad88

… Capabilities" directory

refactor(code-samples): 📝 Turn code samples into snippets for "Packag…

2464d02

…es" directory

refactor(code-samples): 📝 Turn code samples into snippets for "Testin…

50e60d2

…g" directory

fix(code-samples): ✏️ Fix snippet file embed path

676f5ee

refactor(code-samples): 📝 Turn code samples into snippets for "Gotcha…

c0a6b17

…s" directory

fix(code-samples): ✏️ Shorten snippet line syntax

003722b

refactor(code-samples): 📝 Turn code samples into snippets for "Types"…

fd48fe3

… directory

fix(code-samples): ✏️ Fix snippet file embed path

f983690

fix(code-samples): ✏️ Fix snippet file name

27e0623

cont'd

154c7dc

refactor(code-samples): 📝 Turn code samples into snippets for "Expres…

cc8c939

…sions" directory

fix(code-samples): ✏️ Fix snippet file name

999c6c4

refactor(code-samples): 📝 Turn code samples into snippets for "Refere…

706c0d0

…nce Capabilities" directory

refactor(code-samples): 📝 Turn code samples into snippets for "Generi…

cc1f53a

…cs" directory

fix(code-samples): ✏️ Fix snippet file embed path

bb74be7

fix(code-samples): ✏️ Shorten snippet line syntax

2e6bc8a

refactor(code-samples): 📝 Turn code samples into snippets for "C-FFI"…

57bbbeb

… directory

refactor(code-samples): 📝 Turn code samples into snippets for "Append…

5b35814

…ices" directory

fix(code-samples): ✏️ Fix snippet file name

420d05a

fix(code-samples): ✏️ Fix snippet file embed path

1a22c1a

.gitignore: + /.vscode

45180f5

feat(snippets): 🔧 Add snippet inline run JS

73e2d7e

feat(snippets): ✨ Add button to run snippet inline

d6fa1f8

and display result below

ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Apr 30, 2024

shaedrich mentioned this pull request Apr 30, 2024

Add ability to run code examples in the playground #340

Open

shaedrich added 3 commits April 30, 2024 16:19

feat(config): 🔧 Activate mkdocs attr_list and pymdownx.emoji extensions

8594ce3

fix(snippets): ✏️ Send POST request to evaluate.json API endpoint

1114b7e

and fetch snippet from raw git

fix(config): ✏️ Remove redundant implicit prefix

06cc3cf

chore(spelling): Add "fontawesome" to wordlist

d8565ca

Co-authored-by: SeanTAllen <[email protected]> As suggested in ponylang#543 (comment)

Update .markdown-lint.yml

82929f6

Co-authored-by: Sean T. Allen <[email protected]> As suggested in ponylang#543 (comment)

shaedrich changed the title ~~[4/?] Add ability to run code examples in the playground: Run code samples inline~~ [5/?] Add ability to run code examples in the playground: Run code samples inline May 20, 2024

shaedrich added 3 commits May 22, 2024 20:22

Merge branch 'main' into code-samples-run-inline

1b074ef

refactor(code-samples): 📝 Revert non-pony code samples

937c90e

Co-authored-by: Joe Eli McIlvain <[email protected]> As requested in ponylang#544 (comment) From db1eb11

Revert non-pony error message code samples

0bc061c

Co-authored-by: Joe Eli McIlvain <[email protected]> As requested in ponylang#544 (comment) From db1eb11 Follow-up to 3339fd2

shaedrich added a commit that referenced this pull request Jun 5, 2024

Copy changes from #543

098682c

shaedrich closed this Jun 5, 2024

ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Jun 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

shaedrich commented Apr 30, 2024 •

edited

shaedrich commented May 1, 2024

SeanTAllen commented May 14, 2024

SeanTAllen commented May 14, 2024 •

edited

netlify bot commented May 14, 2024 •

edited

shaedrich commented Jun 5, 2024

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

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

Conversation

shaedrich commented Apr 30, 2024 • edited

shaedrich commented May 1, 2024

SeanTAllen commented May 14, 2024

SeanTAllen commented May 14, 2024 • edited

netlify bot commented May 14, 2024 • edited

👷 Deploy request for pony-tutorial pending review.

shaedrich commented Jun 5, 2024

shaedrich commented Apr 30, 2024 •

edited

SeanTAllen commented May 14, 2024 •

edited

netlify bot commented May 14, 2024 •

edited