-
Notifications
You must be signed in to change notification settings - Fork 40
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.
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
Add markdeck script #34
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
13a6cf9
Add markdeck script
jceb fe113b7
Add documentation for ./markdeck
jceb b803fb7
Set a trap to delete the docker-compose generation after exit
jceb d01c588
Make the port dynamically assignable
jceb 7086fe1
Make sure existing files aren't overwritten
jceb da70332
Add missing if statement
jceb 78254a8
Create scaffolding only if it's not there yet
jceb 7e1294a
Start markdeck only when there's a presentation in the current folder
jceb File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,319 @@ | ||
| #!/bin/bash | ||
| # combined script that includes the docker-compose configuration | ||
| set -ue | ||
|
|
||
| BUILD=deck | ||
| VERSION=0.1 | ||
| PORT=8080 | ||
|
|
||
| printHelp () { | ||
| echo "$(basename "$0") [-h|--help|-v|--version] [command]" | ||
| echo | ||
| echo "Commands:" | ||
| echo -e "\tstart: start markdeck server in the current folder (default)" | ||
| echo -e "\tstop: stop markdeck server" | ||
| echo -e "\tpull: pull docker images (this only has to happen once, at the start it will happen automatically)" | ||
| echo -e "\tupdate: update markdeck executable" | ||
| echo -e "\tscaffold: create an example presentation in the current folder" | ||
| } | ||
|
|
||
| printVersion () { | ||
| echo "$(basename "$0") v${VERSION}" | ||
| } | ||
|
|
||
| testOwnership () { | ||
| local dir="$1" | ||
| if [ $(stat -c %U "${dir}") != "${USER}" ]; then | ||
| echo "[ERR] The output folder '${dir}' MUST be owned by you!" 1>&2 | ||
| echo "[ERR] Please change ownership to yourself ('sudo chown ${USER} ${dir}'), or" 1>&2 | ||
| echo "[ERR] remove '${dir}' completely ('sudo rm -rf ${dir}')." 1>&2 | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| createFolder () { | ||
| mkdir -p "${1}" | ||
| } | ||
|
|
||
| createComposeFile () { | ||
| tmpfile=$(mktemp) | ||
| cat > "${tmpfile}" << EOF | ||
| version: "3.2" | ||
|
|
||
| services: | ||
| markdeck: | ||
| image: "arne/markdeck-pandoc:0.34" | ||
| user: "\$MARKDECK_USER" | ||
| volumes: | ||
| - type: bind | ||
| source: ${PWD}/ | ||
| target: /source | ||
| read_only: true | ||
| - type: bind | ||
| source: ${PWD}/${BUILD} | ||
| target: /target | ||
|
|
||
| web: | ||
| image: "arne/markdeck-liveserver:0.2" | ||
| ports: | ||
| - "${PORT}:8080" | ||
| volumes: | ||
| - type: bind | ||
| source: ${PWD}/${BUILD} | ||
| target: /target | ||
| depends_on: [markdeck] | ||
|
|
||
| pdf: | ||
| image: "arne/markdeck-decktape:0.5" | ||
| volumes: | ||
| - type: bind | ||
| source: ${PWD}/${BUILD} | ||
| target: /slides | ||
| shm_size: 1G | ||
| depends_on: [markdeck, web] | ||
|
|
||
| standalone: | ||
| image: "arne/markdeck-standalone:0.2" | ||
| volumes: | ||
| - type: bind | ||
| source: ${PWD}/${BUILD} | ||
| target: /target | ||
| depends_on: [web] | ||
|
|
||
| helper: | ||
| image: "arne/markdeck-helper:0.2" | ||
| ports: | ||
| - "$((${PORT}+1)):8081" | ||
|
|
||
| a2sketch: | ||
| image: "arne/a2sketch:0.11" | ||
| volumes: | ||
| - type: bind | ||
| source: ${PWD}/a2s-custom-types | ||
| target: /custom-types | ||
| read_only: true | ||
| EOF | ||
|
|
||
| echo "${tmpfile}" | ||
| } | ||
|
|
||
| dockerCompose () { | ||
| composefile="$(createComposeFile)" | ||
| trap "rm -f '${composefile}'; exit" EXIT SIGHUP SIGTERM SIGINT SIGKILL SIGQUIT | ||
| docker-compose -f "${composefile}" "${@}" | ||
| } | ||
|
|
||
| update () { | ||
| curl -# -S -f -L -O "${0}" https://raw.githubusercontent.com/arnehilmann/markdeck/master/markdeck | ||
| chmod a+x "${0}" | ||
| echo "Updated from $(printVersion) to $("${0}" --version)." | ||
| } | ||
|
|
||
| scaffold () { | ||
| if ! isPresentationFolder; then | ||
| mkdir -p assets/css | ||
|
|
||
| if [ ! -e slides.md ]; then | ||
| echo "Creating slides.md." | ||
| cat > slides.md << "EOF" | ||
| --- | ||
| title: markdeck scaffold | ||
| pdf: markdeck-scaffold.pdf | ||
| slideNumber: true | ||
| controls: true | ||
| --- | ||
|
|
||
| # first slide {bg=#eee} | ||
|
|
||
| made with [markdeck](https://arnehilmann.github.io/markdeck/){target="_blank"} | ||
|
|
||
| ```render_a2s | ||
| #----------. | ||
| |[markdeck]| | ||
| '----------# | ||
| [markdeck]: {"fill": "Teal", "fillStyle": "solid"} | ||
| ``` | ||
|
|
||
| <small> | ||
| interesting links: | ||
| [your main deck](/){target="_parent"} | ||
| • [markdown/slide side-by-side](/explain.html) | ||
| • [utilities](//localhost:8081/){target="_blank"} | ||
| </small> | ||
|
|
||
| ⚪ ⚪ ⚪ | ||
| EOF | ||
| fi | ||
|
|
||
| if [ ! -e assets/explain.html ]; then | ||
| echo "Creating assets/explain.html." | ||
| cat > assets/explain.html << "EOF" | ||
| <html> | ||
| <head> | ||
| <style> | ||
| body { | ||
| margin: 0; | ||
| } | ||
| .box { | ||
| display:inline-block; | ||
| padding: 0; | ||
| } | ||
| .deck { | ||
| width: 60%; | ||
| } | ||
| .source { | ||
| width: 38%; | ||
| border-left: 4px dashed #ccc; | ||
| } | ||
|
|
||
| </style> | ||
| </head> | ||
| <body> | ||
| <div class="box deck"> | ||
| <iframe | ||
| id="deck" | ||
| src="index.html?in_explain" | ||
| style="border: 0;" | ||
| frameborder="0" | ||
| scrolling="no" height="100%" width="100%" align="left" ></iframe> | ||
| </div> | ||
| <div class="box source"> | ||
| <iframe | ||
| id="source" | ||
| src="slides.combined.md.txt" | ||
| frameborder="0" | ||
| height="100%" width="100%" align="left" ></iframe> | ||
| </div> | ||
|
|
||
| <script> | ||
| var deck = document.getElementById('deck'); | ||
| var source = document.getElementById('source'); | ||
|
|
||
| var split_source = function(doc) { | ||
| // console.log(doc); | ||
| var myText = doc.getElementsByTagName("pre")[0]; | ||
| // console.log(myText); | ||
| var lines = myText.innerHTML.split("\n"); | ||
| var numLines = lines.length; | ||
| var i; | ||
| var currentSection = undefined; | ||
| var header = false; | ||
|
|
||
| window.sections = Array(); | ||
|
|
||
| for (i = 0; i < numLines; i++) { | ||
| var line = lines[i]; | ||
| // console.log("line: " + line); | ||
| if (line.indexOf('---') == 0) { | ||
| header = !header; | ||
| continue; | ||
| } | ||
| if (header) { | ||
| continue; | ||
| } | ||
| if (line.indexOf('# ') == 0) { | ||
| if (currentSection) { | ||
| window.sections.push(currentSection.join("\n")); | ||
| } | ||
| // console.log("slide header found: " + line); | ||
| currentSection = Array(); | ||
| currentSection.push('<pre>'); | ||
| currentSection.push(line); | ||
| } else { | ||
| if (currentSection) { | ||
| currentSection.push(line); | ||
| } | ||
| } | ||
| } | ||
| window.sections.push(currentSection.join("\n")); | ||
| console.log(window.sections); | ||
| } | ||
|
|
||
| document.getElementById('deck').onload = function(event) { | ||
| var sourceDoc = source.contentDocument; | ||
| split_source(sourceDoc.documentElement); | ||
| var deckWindow = deck.contentWindow; | ||
| var update_source = function() { | ||
| // console.log("updating source view"); | ||
| var slideNr = deckWindow.Reveal.getIndices().h; | ||
| source.contentDocument.documentElement.innerHTML = '<div style="padding-left: 1em; position: relative; top: 50%; transform: translateY(-50%);"><em>slide source</em></br></br>' + window.sections[slideNr] + "</div>"; | ||
| }; | ||
| update_source(); | ||
| deckWindow.Reveal.addEventListener('slidechanged', update_source); | ||
| deckWindow.focus(); | ||
| }; | ||
| </script> | ||
| </body> | ||
| </html> | ||
| EOF | ||
| fi | ||
|
|
||
| if [ ! -e assets/css/slides.scss ]; then | ||
| echo "Creating assets/css/slides.scss." | ||
| cat > assets/css/slides.scss << "EOF" | ||
| /* put your styles in this file */ | ||
| EOF | ||
| fi | ||
|
|
||
| echo "Yay, go ahead and create you presentation!" | ||
| echo "Write the slides in slides.md." | ||
| echo "Store images and styles in assets/." | ||
| echo "Run '$(basename "${0}")' to compile the presentation." | ||
| else | ||
| echo "No scaffolding needed, there's already a presentation in this folder (slides.md)." | ||
| echo "Run '$(basename "${0}")' to compile the presentation." | ||
| return 1 | ||
| fi | ||
| } | ||
|
|
||
| isPresentationFolder () { | ||
| shopt -s nullglob | ||
| res=1 | ||
| [ -n "$(echo ${1:-.}/slide*.md)" ] && res=0 | ||
| shopt -u nullglob | ||
| return $res | ||
| } | ||
|
|
||
| startMarkdeck () { | ||
| if ! isPresentationFolder; then | ||
| echo "This folder doesn't contain a markdeck presentation." 1>&2 | ||
| echo "Run '$(basename "${0}") scaffold' to create one." 1>&2 | ||
| return 1 | ||
| fi | ||
| createFolder "${BUILD}" | ||
| testOwnership "${BUILD}" | ||
| MARKDECK_USER=$(stat -c %u:%g "${BUILD}") dockerCompose up | ||
| } | ||
|
|
||
| if [ $# -ge 1 ]; then | ||
| case "${1}" in | ||
| 'scaffold' ) | ||
| scaffold | ||
| ;; | ||
| 'pull' ) | ||
| dockerCompose pull | ||
| ;; | ||
| 'stop' ) | ||
| dockerCompose down | ||
| ;; | ||
| 'update' ) | ||
| update | ||
| ;; | ||
| '-h' | '--help' ) | ||
| printHelp | ||
| ;; | ||
| '-v' | '--version' ) | ||
| printVersion | ||
| ;; | ||
| 'start' ) | ||
| startMarkdeck | ||
| ;; | ||
| * ) | ||
| printHelp | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| else | ||
| startMarkdeck | ||
| fi | ||
| exit $? | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But this is still static, isn't it?
I would expect something like
PORT=${1:-8080}orPORT=${PORT:-8080}or the like...and: gets the correct port number displayed in the mark deck console (I mean at the end of the loop output)?