Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
shaedrich wants to merge 37 commits into from
Closed

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

shaedrich wants to merge 37 commits into from

Conversation

@shaedrich
Copy link
Collaborator

@shaedrich shaedrich commented Apr 30, 2024 •
edited
Loading

See #340

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

shaedrich and others added 29 commits April 21, 2024 05:35
@shaedrich
feat(config): Activate mkdocs snippets extension
765384b
@shaedrich
refactor(code-samples): Turn code samples into snippets
c1a8a22
@shaedrich
fix(config): Add missing colon
58e6599 
to mark array entry as object rather than a string
@shaedrich
feat(config): Enable check_paths option for snippets
62a001d
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
c6b9959
@shaedrich
Merge branch 'code-samples-separate-files' of https://github.com/shae…
dc86c15 
…drich/pony-tutorial into code-samples-separate-files
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Object…
70dad88 
… Capabilities" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Packag…
2464d02 
…es" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Testin…
50e60d2 
…g" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
676f5ee
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Gotcha…
c0a6b17 
…s" directory
@shaedrich
fix(code-samples): ✏️ Shorten snippet line syntax
003722b
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Types"…
fd48fe3 
… directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
f983690
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
27e0623
@shaedrich
cont'd
154c7dc
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Expres…
cc8c939 
…sions" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
999c6c4
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Refere…
706c0d0 
…nce Capabilities" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Generi…
cc1f53a 
…cs" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
bb74be7
@shaedrich
fix(code-samples): ✏️ Shorten snippet line syntax
2e6bc8a
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "C-FFI"…
57bbbeb 
… directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Append…
5b35814 
…ices" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
420d05a
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
1a22c1a
@shaedrich
.gitignore: + /.vscode
45180f5
@shaedrich
feat(snippets): 🔧 Add snippet inline run JS
73e2d7e
@shaedrich
feat(snippets): ✨ Add button to run snippet inline
d6fa1f8 
and display result below
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label Apr 30, 2024
@shaedrich shaedrich mentioned this pull request Apr 30, 2024
Open
@shaedrich
Copy link
Collaborator Author

shaedrich commented May 1, 2024

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
Copy link
Member

SeanTAllen commented May 14, 2024

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

@SeanTAllen
Copy link
Member

SeanTAllen commented May 14, 2024 •
edited
Loading

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.

@shaedrich
chore(spelling): Add "fontawesome" to wordlist
d8565ca 
Co-authored-by: SeanTAllen <sean@seantallen.com>

As suggested in ponylang#543 (comment)
@netlify
Copy link

netlify bot commented May 14, 2024 •
edited
Loading

👷 Deploy request for pony-tutorial pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 0bc061c

@shaedrich
Update .markdown-lint.yml
82929f6 
Co-authored-by: Sean T. Allen <sean@seantallen.com>

As suggested in ponylang#543 (comment)
@shaedrich 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
@shaedrich
Merge branch 'main' into code-samples-run-inline
1b074ef
@shaedrich
refactor(code-samples): 📝 Revert non-pony code samples
937c90e 
Co-authored-by: Joe Eli McIlvain <joe.eli.mac@gmail.com>

As requested in ponylang#544 (comment)

From db1eb11
@shaedrich
Revert non-pony error message code samples
0bc061c 
Co-authored-by: Joe Eli McIlvain <joe.eli.mac@gmail.com>

As requested in ponylang#544 (comment)

From db1eb11

Follow-up to 3339fd2
shaedrich added a commit that referenced this pull request Jun 5, 2024
@shaedrich
Copy changes from #543
098682c
@shaedrich
Copy link
Collaborator Author

shaedrich commented Jun 5, 2024

Closed in favor of #554 (not a fork)

@shaedrich shaedrich closed this Jun 5, 2024
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shaedrich @SeanTAllen @ponylang-main