{"id":39467355,"url":"https://github.com/3mdeb/remark-templates","last_synced_at":"2026-01-18T04:51:19.950Z","repository":{"id":77148964,"uuid":"599645242","full_name":"3mdeb/remark-templates","owner":"3mdeb","description":"Templates for remark.js markdown processor used by 3mdeb","archived":false,"fork":false,"pushed_at":"2024-09-18T19:53:09.000Z","size":7686,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-09-19T11:42:22.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3mdeb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-02-09T15:26:07.000Z","updated_at":"2024-09-11T07:47:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"848a8e39-8ca2-4680-9408-bd5cbee7c499","html_url":"https://github.com/3mdeb/remark-templates","commit_stats":{"total_commits":12,"total_committers":5,"mean_commits":2.4,"dds":0.5833333333333333,"last_synced_commit":"55f00abcacd390fec962d9aadc989ae78b66f240"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/3mdeb/remark-templates","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3mdeb%2Fremark-templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3mdeb%2Fremark-templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3mdeb%2Fremark-templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3mdeb%2Fremark-templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3mdeb","download_url":"https://codeload.github.com/3mdeb/remark-templates/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3mdeb%2Fremark-templates/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28530347,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-01-18T04:51:19.868Z","updated_at":"2026-01-18T04:51:19.934Z","avatar_url":"https://github.com/3mdeb.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Remark Templates\n\nTemplates for [remark.js](https://remark.js.org/) markdown processor. Used by\n3mdeb to generate presentations, reports, and other documents with markdown\ntext tracked in git.\n\n## Available templates\n\nFollowing templates are currently available in this repository:\n\n* `3mdeb-catalogue-template`\n    - template for creating 3mdeb service catalogues\n* `3mdeb-pet-presentation-template`\n    - template for 3mdeb PET presentations\n* `3mdeb-presentation-template`\n    - template for generic 3mdeb presentations (such as technical conferences,\n    or internal presentations)\n* `3mdeb-report-template`\n    - A4 report template - can be used for creating A4-sized PDFs with various\n    technical reports\n* `3mdeb-training-presentation-template`\n    - template for generic 3mdeb training presentations (should be avoided for\n     new content - use either PET or OST2)\n* `dasharo-presentation-template`\n    - template for various Dasharo-related presentations\n\n## Markdown syntax\n\nApart from the pretty standard markdown syntax, there are a few additional\nchanges worth noting.\n\n### Page break\n\nFollowing syntax is used for page break:\n\n```md\n---\n```\n\nEverything below that line, will render on a new page.\n\n### Styles\n\nEach template can define some styles in `\u003cTEMPLATE_DIR\u003e/css/styles.css`. These\ncan be applied to whole pages, or to the individual components.\n\n#### Pages\n\nEach page can use different style. In our templates, we typically have three\nstyles:\n\n* style for the first page,\n* default style for the content pages,\n* style for the list page.\n\n```md\nclass: center, middle, intro\n\n## DOCUMENT_TITLE\n---\n```\n\n#### Components\n\nStyles can also be applied to individual components (such as: code blocks,\nimages, text). For example, following syntax can be used to apply `center`\nstyle for some text:\n\n```md\n.center[Text to be centered]\n```\n\n#### Common styles\n\nThere are some common and useful styles you will face in many of templates.\nSome of them are described below. A full list of styles definition for the\ngiven template can be found in: `\u003cTEMPLATE_DIR\u003e/css/styles.css` file.\n\n* Common way of inserting centered image:\n\nCreate `img` directory in main directory of repository:\n\n```shell\nmkdir img\n```\n\n\u003e In this case image will be reduced to 15% in size. There are multiple styles\n\u003e for image size defined, typically with 5% step.\n\n```md\n.center[.image-15[![](/img/image.png)])]\n```\n\nUsing that syntax, with assumption that `remark-remplates` and `img` are in\nyour main directory of repository, will cause that presentation render\ncorrectly even if it would be under subdirectories (in bigger presentation\nrepositories you may like to have some division of presentation or archive).\n\n* Text centered in a single column:\n\n```md\n.column-1[\n.middle-1[your-text]\n]\n```\n\n* Text in two columns:\n\n```md\n.column-2[\n.left-2[your-text]\n.right-2[your-text]\n]\n```\n\n* Text in 3 columns:\n\n```md\n.column-3[\n.left-3[your-text]\n.middle-3[your-text]\n.right-3[your-text]\n]\n```\n\n* Text in 4 columns:\n\n```md\n.column-4[\n.left-4[your-text]\n.left-middle-4[your-text]\n.right-middle-4[your-text]\n.right-4[your-text]\n]\n```\n\n* Footnote:\n\n\u003e A footnote to be displayed on the bottom of the slide. To be used for\n\u003e providing source of information, for example.\n\n```md\n.footnote[Source: https://wikipedia.org]\n```\n\n## Usage\n\n### Create HTML file\n\nTo use `remark-templates`, it should be added as a submodule to your\ndocumentation/presentation repository main directory. If it has not been done\nalready, you should do that with:\n\n```shell\ngit submodule add git@github.com:3mdeb/remark-templates.git remark-templates\n```\n\n* Copy the template markdown file from target templates directory, e.g.:\n\n```shell\ncp 3mdeb-presentation-template/3mdeb-presentation-template.md title-of-your-choice.md\n```\n\n* Execute the `create-html.sh` script for a selected\n  [template](#available-templates):\n\n```md\n./remark-templates/scripts/create-html.sh 3mdeb-presentation-template \\\n  \"Title of Your Presentation\" title-of-your-choice.md\n```\n\n* Now you can keep editing your `title-of-your-choice.md` file with content,\n  while reviewing the rendered output form HTML file as shown in the next\n  section.\n\n### Preview the HTML file\n\n\u003e Chrome / Chromium browser is recommended\n\n* Start the HTTP server:\n\n  ```python\n  python -m http.server 8080\n  ```\n\n* Open rendered HTML in browser, using the `http://127.0.0.1:8080/` URL\n\n## Generate PDF file\n\nThe ultimate goal of these templates is usually to generate a PDF file from\nmarkdown content.\n\n### Manual\n\n\u003e Chrome / Chromium browser is recommended\n\n* Open the preview in browser as shown above, and simply print to file\n    - make sure to check the `Background graphics` under `More settings`\n\n### Automated\n\nYou can also use a scripted way to generate the PDF.\n\n#### Requirements\n\n* [Docker](https://docs.docker.com/engine/install/ubuntu/) installed\n* `Python` installed (for setting up the HTTP server)\n* the `\u003ctitle\u003e` tag in each HTML file should be present - the printed filename\n  will be based on that (spaces will be replaced with underscores)\n\n#### Printing\n\n* Go to the directory with your HTML files\n\n* Print everything from current directory and subdirectories:\n\n```shell\n./remark-templates/scripts/print-pdfs.sh .\n```\n\n* The resulting HTML files could be found in the `pdf` subdirectory\n\n* Run the script with no arguments to get more information on available options\n\n## Known Issues\n\n* When printing from the browser, the font on the first page may be too thick.\n    - to fix this refresh the page or clear the cache\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3mdeb%2Fremark-templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3mdeb%2Fremark-templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3mdeb%2Fremark-templates/lists"}