{"id":15130837,"url":"https://github.com/carsonslovoka/slides","last_synced_at":"2026-01-17T03:47:07.790Z","repository":{"id":255816378,"uuid":"852643604","full_name":"CarsonSlovoka/slides","owner":"CarsonSlovoka","description":"Use Markdown to Easily Create Slides","archived":false,"fork":false,"pushed_at":"2024-11-04T10:59:22.000Z","size":373,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T20:12:18.392Z","etag":null,"topics":["chinese","docker","go","golang","markdown","slides","taiwan"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CarsonSlovoka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-05T06:59:23.000Z","updated_at":"2024-11-04T10:59:25.000Z","dependencies_parsed_at":"2024-09-15T10:35:01.151Z","dependency_job_id":"033602ed-52c9-42f2-91b2-c1d18e08291c","html_url":"https://github.com/CarsonSlovoka/slides","commit_stats":{"total_commits":72,"total_committers":1,"mean_commits":72.0,"dds":0.0,"last_synced_commit":"cb59d8bf96f8767c687b55d820612e8dd3582626"},"previous_names":["carsonslovoka/slides"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarsonSlovoka%2Fslides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarsonSlovoka%2Fslides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarsonSlovoka%2Fslides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CarsonSlovoka%2Fslides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CarsonSlovoka","download_url":"https://codeload.github.com/CarsonSlovoka/slides/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393572,"owners_count":20931813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chinese","docker","go","golang","markdown","slides","taiwan"],"created_at":"2024-09-26T03:07:07.337Z","updated_at":"2026-01-17T03:47:07.746Z","avatar_url":"https://github.com/CarsonSlovoka.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Slides\n\n主要透過[reveal.js](https://github.com/hakimel/reveal.js)來生成投影片\n\n## Download\n\n您可以自己[Build](#build)，如果不想要建立，可以到[release的頁面下](https://github.com/CarsonSlovoka/slides/releases)下載對應平台的zip檔案，裡面有build完成的執行檔\n\n## Build\n\n```yaml\ngit clone https://github.com/CarsonSlovoka/slides.git\ncd slides\ngit submodule update --init --recursive reveal.js\ngit submodule update --init --recursive plugin/guess\ngit submodule update --init --recursive plugin/marker\n# go install -ldflags \"-s -w\" -tags tmpl  # 執行檔GOPATH/bin目錄\ngo build -ldflags \"-s -w\" -tags tmpl\n```\n\n\u003e 建議打包的時候可以包含`-tags tmpl`，他可以將預設的[slides.gohtml](slides.gohtml)[嵌入](embed_tmpl.go)\n\u003e\n\u003e 使得當您不想要再對樣板修改時，也不在需要提供樣板\n\n## USAGE\n\n拿到此執行檔後，可以將執行檔的位置加入環境變數\n\n接著在你想要的工作目錄，建立三種內容\n\n1. 📂 md: 這是一個目錄，裡面放所有你想要投影的md檔案\n2. (optional ) 📜 slides.gohtml, 這是一個模板你可以抓取[預設的內容後修改](slides.gohtml), 如果你不想準備此模板，請用`go build -tags tmpl`去生成執行檔\n\n    注意! slides.gohtml裡面對於md的分隔符號是`\\n`，如果你想要改成`\\r\\n`可以[調整為](https://github.com/CarsonSlovoka/slides/blob/84bcf2f776ffc87d4d96f051ad3a2da856b43123/slides.gohtml#L16-L17)\n\n    ```html\n    data-separator=\"^\\r\\n---\\r\\n\"\n    data-separator-vertical=\"^\\r\\n----\\r\\n\"\n    ```\n\n\n3. (optional ) 📂 assets: 如果你在md之中，有想要用img來加入本地的圖片，可以考慮將圖片路徑保存在此目錄。使用連結`/assets`會自動以此目錄為相對位置開始找尋\n\n啟動上可以直接\n```yaml\nslides.exe\nslides.exe -port=12345 # port預設用8080, 如果被佔用或者不喜歡可以改成其他，或者指定為0會自動抓取\n\n# 如果你不喜歡把幻燈片都保存在md的目錄，你可以自定義您的目錄名稱，啟動上使用-md來告知\nslides.exe -md=\"mySlides\"\n```\n\n或者用https\n\n```\nslides.exe -tls\n```\n\n## Docker\n\n提供兩種方法\n\n1. 使用[carsonTseng/slides](https://hub.docker.com/layers/carsontseng/slides/v0.2.0/images/sha256-99243e1e2dbc0ec22ad8e1b849cbdc6340ca51f80b7dbe2d4444f3a70693fc3d): [把slides當作image](https://github.com/CarsonSlovoka/slides/blob/b5166bdd88e1af3a89651e399a744f6c807dc2f9/docker/Dockerfile.example#L10), 所以你還要自己額外寫Dockerfile才可以看到結果，可以參考[Dockerfile.example](docker/Dockerfile.example)\n2. 使用[carsonTseng/slides-cmd](https://hub.docker.com/repository/docker/carsontseng/slides-cmd/general): 好處是你不需要再寫Dockerfile，可以利用綁定掛載(Bind mounts)的方式,來讀取到要被渲染的內容，請參考以下範例\n\n    ```yaml\n    # 使用powershell\n    docker run -p 8080:8080 -e PORT=8080 `\n      -e MD_DIR=\"docs\" ` # 放到md的所在目錄\n      -v .\\docs:/usr/local/bin/docs ` # 後面的docs需與MD_DIR所指定的目錄相同\n      -v .\\slides.gohtml/:/usr/local/bin/slides.gohtml ` # 可選，如果你需要自定義slides.gohtml也可以告知\n      -v .\\assets:/usr/local/bin/assets ` # 可選(assets目錄，預設就會被當成fs，不需要再加到FS_DIRS去)\n      -e FS_DIRS=\"pages,static,tmpl\" ` # 即 -fs pages -f static -fs tmpl\n      -v .\\pages:/usr/local/bin/pages ` # 這些內容對應於 FS_DIRS # 其中的.\\docs應該於您目前的工作目錄中能找到\n      -v .\\static:/usr/local/bin/static ` # 同上\n      -v .\\tmpl/:/usr/local/bin/tmpl ` # 同上\n      --name my-slides-example carsontseng/slides-cmd:v0.2.1\n    ```\n\n\n## Plugin 自定義插件\n\n可以參考[此commit](https://github.com/CarsonSlovoka/slides/commit/b239af8f9b9ffcf27bbb8b00e46e9f2fb516cf47)\n\n裡面製作了一個[guessEx的插件](https://github.com/CarsonSlovoka/slides/blob/b239af8f9b9ffcf27bbb8b00e46e9f2fb516cf47/plugin/guessEx/guessEx.mjs)\n\n當你製作好plugin之後，可以在工作目錄下建立一個plugin的目錄，將其內容放入[即可被程式抓到](https://github.com/CarsonSlovoka/slides/blob/68d94531130c50deb653260bcb094f11cf03071b/main.go#L212)\n\n之後[建立屬於您自己的slides.gohtml，導入該plugin](https://github.com/CarsonSlovoka/slides/blob/68d94531130c50deb653260bcb094f11cf03071b/slides.gohtml#L47)即可\n\n### [3-rd plugins](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarsonslovoka%2Fslides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarsonslovoka%2Fslides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarsonslovoka%2Fslides/lists"}