{"id":22624361,"url":"https://github.com/leso-kn/paged-markdown","last_synced_at":"2025-03-29T03:15:47.242Z","repository":{"id":100481064,"uuid":"338624454","full_name":"leso-kn/paged-markdown","owner":"leso-kn","description":"A modern approach to creating slide-based presentations / paged text documents","archived":false,"fork":false,"pushed_at":"2023-02-16T19:32:50.000Z","size":19,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"presentation","last_synced_at":"2025-02-03T13:12:37.599Z","etag":null,"topics":["markdown","presentation","text-document","word-processing"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/leso-kn.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":"2021-02-13T17:05:29.000Z","updated_at":"2023-10-31T10:21:00.000Z","dependencies_parsed_at":"2023-05-15T04:00:44.181Z","dependency_job_id":null,"html_url":"https://github.com/leso-kn/paged-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leso-kn%2Fpaged-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leso-kn%2Fpaged-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leso-kn%2Fpaged-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leso-kn%2Fpaged-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leso-kn","download_url":"https://codeload.github.com/leso-kn/paged-markdown/tar.gz/refs/heads/presentation","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246131335,"owners_count":20728303,"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":["markdown","presentation","text-document","word-processing"],"created_at":"2024-12-09T00:13:45.991Z","updated_at":"2025-03-29T03:15:47.213Z","avatar_url":"https://github.com/leso-kn.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Online Demo](https://img.shields.io/static/v1?label=Demo\u0026message=View%20in%20Browser\u0026color=blue)](https://lesosoftware.com/paged-markdown-demo)\n\n![banner animation](https://user-images.githubusercontent.com/7886606/108355215-cec16980-71ea-11eb-8f7e-fe90e9c1cb11.gif)\n\n# Paged Markdown\n\nPaged Markdown (or `paged.md` for short) is a modern approach to creating slide-based presentations.\n\nBesides presentations, there is also a dialect for creating text documents with multiple pages (paper, essay, etc.) on [this branch](https://github.com/leso-kn/paged-markdown/tree/text-document).\n\n## About\n\nAs the name suggests, `paged.md` is based on [Markdown](https://daringfireball.net/projects/markdown/).\n\nUnlike with classical presentation software, there's no official editor for creating slides (though [Visual Studio Code](https://code.visualstudio.com/) is recommended). In fact, any text editor can be used to create and edit Paged Markdown presentations.\n\nThe result can be displayed (presented) in any modern browser at any stage of the creation process, meaning there's no need to convert or render anything between editing and presenting (presentation files already have the .htm file extension).\n\n## Getting started\n\nFor editing, it is recommended to use [Visual Studio Code](https://code.visualstudio.com/), since it provides a variety of features to edit Markdown documents.\n\n1. Download or clone this repository\n2. Rename the folder to the desired name of your presentation\n3. Open the folder in Visual Studio Code\n   * Alternatively: Open `presentation.htm` in any text editor of your choice\n\n### Quick tutorial\n\n* To preview or display your presentation, open it inside any modern browser (Firefox, Chrome etc.)\n* In Visual Studio Code, you can use the Markdown Preview feature directly\n* Use regular Markdown to create your presentation\n* As usual with Markdown, HTML can be used as well in the entire document\n  * This allows for more flexible formatting\n* Slides are arranged inside `\u003cpage\u003e` tags\n\n\u003e To switch between slides in Visual Studio Code, edit the number inside `page:nth-of-type(...)` in the `\u003cstyle\u003e` tag in the very end of your `presentation.htm`.\n\n### Design\n\nYou can change colors and adjust / extend the design of your slides by customizing `design.css` to your needs and taste.\n\nThere is also `logic.css`. Feel free to look around in here too, this file is supposed to handle the more generic slide design like animations and the base definition of a `\u003cpage\u003e` (slide) tag.\n\n## FAQ\n\n### Visual Studio Code\n\n**`\"Some content has been disabled in this document\"`**\n\nBy default, the Markdown preview of Visual Studio Code blocks external urls.\n\nThis is actually a really handy behaviour in the case of `paged.md`: The javascript logic, that provides keybindings and markdown rendering inside the web browser, is not needed during editing.\n\nSince it is loaded from an external server ([link](https://lesosoftware.com/paged.md)), Code automatically prevents the script from being executed.\n\nThe warning itself can just be hidden by clicking on it and selecting _'Disable preview security warning in this workspace'_.\n\n## Limitations\n\nA common usecase with slides is to export them to the pdf format.\n\nThis _is_ possible with Paged Markdown presentations, but the way to do it at the moment is not exactly beautiful:\n\nTo convert your slides to pdf, simply open the presentation in your web browser and navigate to the first slide. Press `CTRL+P` to print the current page and select \"Save to PDF\". You will need to repeat this step for each slide (for filenames, choose a new folder and put something like `01.pdf`, `02.pdf`, `...`).\n\nAfter saving all slides, you can use any PDF-merge tool to combine the files into a single pdf document. On Linux, there's also the `pdfunite` utility, that can be used for this. Nevertheless, this is certainly not a nice way to do it and is most likely to be improved in the future!\n\n---\n\nPaged Markdown – Copyright (c) Lesosoftware 2021\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleso-kn%2Fpaged-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleso-kn%2Fpaged-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleso-kn%2Fpaged-markdown/lists"}