Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/objcio/markdown-playgrounds
A Markdown Editor that can execute Swift code
https://github.com/objcio/markdown-playgrounds
macos markdown markdown-editor swift
Last synced: 29 days ago
JSON representation
A Markdown Editor that can execute Swift code
- Host: GitHub
- URL: https://github.com/objcio/markdown-playgrounds
- Owner: objcio
- License: mit
- Created: 2019-03-08T12:58:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-10T07:04:15.000Z (almost 5 years ago)
- Last Synced: 2024-09-30T00:44:20.294Z (about 1 month ago)
- Topics: macos, markdown, markdown-editor, swift
- Language: Swift
- Homepage: https://talk.objc.io/collections/markdown-playgrounds
- Size: 117 KB
- Stars: 577
- Watchers: 24
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🎰 Markdown Playgrounds for Swift
[](https://swift.org/download/) [](https://github.com/apple/swift-package-manager) [](https://twitter.com/objcio)
## What it does
This app reads and writes Markdown documents that contain Swift code. The code can be executed too! You can run individual code blocks, or all the blocks in a file.
We're using this app to update our book [Advanced Swift](https://www.objc.io/books/advanced-swift/), and while writing [blog posts](https://www.objc.io/blog/archive/). We find it very useful, and we hope you do too.
## How it works
The app works by sending Swift code to a REPL instance, then reading back the results. Compared to Swift Playgrounds or Xcode's playgrounds, this is quite limiting, but it also means we can keep things simple.
## Learn more
We're documenting the building of this app on [Swift Talk](https://talk.objc.io/collections/markdown-playgrounds), a weekly video series of conversational live-coding hosted by [Chris Eidhof](https://twitter.com/chriseidhof) and [Florian Kugler](https://twitter.com/floriankugler).
The [first episode](https://talk.objc.io/episodes/S01E145-setting-up-a-document-based-app) previews the app, and is free to watch.
- 145: [Setting Up a Document Based App](https://talk.objc.io/episodes/S01E145-setting-up-a-document-based-app) — 🆓 Public
- 146: [Markdown Syntax Highlighting](https://talk.objc.io/episodes/S01E146-markdown-syntax-highlighting) — 🔒 Subscriber
- 147: [Executing Swift Code](https://talk.objc.io/episodes/S01E147-executing-swift-code) — 🔒 Subscriber
- 148: [String Handling](https://talk.objc.io/episodes/S01E148-string-handling) — 🔒 Subscriber
## Building
*Note*: currently this builds, but doesn't run from Xcode. Instead, build and run from the command line.
- You need to have [cmark](https://github.com/commonmark/cmark) installed *from master* (not via homebrew). If you use the version from homebrew, you won't get proper syntax highlighting (specifically: for inline elements).
- This project uses [Swift Package Manager](https://github.com/apple/swift-package-manager). You can either run "swift build" or do "swift package generate-xcodeproj"
Here are the steps as shell commands:
```sh
git clone https://github.com/commonmark/cmark
cd cmark
mkdir build
cd build
cmake ..
make
make test
make install
cd ../..
# Building this project
git clone https://github.com/objcio/markdown-playgrounds
cd markdown-playgrounds
swift build
# If you want to edit this in Xcode
swift package generate-xcodeproj
xed .
```
## Future Direction
This project could head in a number of directions, and there are many useful features we could add. Our main goal is to keep using this for authoring Swift-heavy Markdown, which will guide our decisions when we decide on new features.
To keep things simple, we have collected a list of todos in [todo.txt](todo.txt).
## License
This library is released under the MIT license. See [LICENSE](LICENSE) for details.