{"id":18591855,"url":"https://github.com/sdsc-ordes/technical-presentation","last_synced_at":"2025-11-02T02:30:28.457Z","repository":{"id":244115280,"uuid":"814317014","full_name":"sdsc-ordes/technical-presentation","owner":"sdsc-ordes","description":"Technical presentations with  Reveal.js and tooling to produce PDF/HTML output","archived":false,"fork":false,"pushed_at":"2025-02-14T10:57:57.000Z","size":97146,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T11:38:27.570Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://sdsc-ordes.github.io/technical-presentation","language":"Shell","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/sdsc-ordes.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},"funding":{"github":["hakimel"]}},"created_at":"2024-06-12T19:12:06.000Z","updated_at":"2025-01-03T12:07:36.000Z","dependencies_parsed_at":"2024-06-13T01:16:23.320Z","dependency_job_id":"0445bb27-cf2a-4560-89ee-5081bfef65bc","html_url":"https://github.com/sdsc-ordes/technical-presentation","commit_stats":{"total_commits":2511,"total_committers":347,"mean_commits":7.236311239193084,"dds":"0.29510155316606934","last_synced_commit":"641fdd2fe292fd9cfba9c612e29a977bae168e41"},"previous_names":["sdsc-ordes/technical-presentation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdsc-ordes%2Ftechnical-presentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdsc-ordes%2Ftechnical-presentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdsc-ordes%2Ftechnical-presentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sdsc-ordes%2Ftechnical-presentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sdsc-ordes","download_url":"https://codeload.github.com/sdsc-ordes/technical-presentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239360351,"owners_count":19625791,"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":[],"created_at":"2024-11-07T01:05:15.403Z","updated_at":"2025-11-02T02:30:28.237Z","avatar_url":"https://github.com/sdsc-ordes.png","language":"Shell","funding_links":["https://github.com/sponsors/hakimel"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"docs/logo.svg\" style=\"margin-right: 10pt;width:100pt\" align=\"right\"\u003e\n\u003ch1\u003eTechnical Presentation\u003c/h1\u003e\n\n\u003cbr\u003e\n\nMake technical presentations in Markdown/HTML etc.\n\nThis uses [`revealjs`](https://github.com/hakimel/reveal.js) with some\nmodifications to package to PDF and standalone HTML format. Also it includes a\ncompany `scss` file for design modifications.\n\n**This is a fork of\n[`technical-presentation`](https://github.com/gabyx/technical-presentation.git)\nwith some small modifications for SDSC.**\n\n- **See the\n  [demo presentation here](https://sdsc-ordes.github.io/technical-presentation/gh-pages/demo)**.\n- **See some other\n  [Rust Workshop](https://sdsc-ordes.github.io/technical-presentation/gh-pages/rust-workshop/part-1/#/title-slide)**\n  [src](https://github.com/sdsc-ordes/technical-presentation/tree/feat/rust-workshop).\n- **See some other\n  [C++ presentation here](https://gabyx.github.io/tech-pr-cpp-value-catergories)**\n  [src](https://github.com/gabyx/tech-pr-cpp-value-catergories).\n\nAuthors:\n\n- [Gabriel Nützi](https://github.com/gabyx)\n\n\u003e [!WARNING]\n\u003e\n\u003e This is the `pandoc` tooling branch, if you want a simpler version with\n\u003e `reveal.js` only, use `main-simple`.\n\nCurrent [`revealjs`](https://github.com/hakimel/reveal.js) version: `4.6.1`\n\n## Requirements\n\n### Using [`nix`](https://nixos.org)\n\nYou can enter a development shell with\n\n```shell\nnix develop './tools/nix#default'\n```\n\nwhere all requirements are installed to start working on your first\npresentation.\n\n### DevContainer\n\nThere is a [`.devcontainer`](.devcontainer) to be run over `code` or the\n[devcontainer](https://github.com/devcontainers/cli) CLI. First build the\ncontainer:\n\n```shell\njust build-dev-container\n```\n\nor with `docker` instead of `podman`:\n\n```shell\njust container_mgr=docker build-dev-container\n```\n\n### Manual\n\nYou need the following tools:\n\n- `bash`\n- `just`\n- `rsync`\n- `watchman`\n- `npm`\n- `yarn`\n\n## Usage\n\n1. **`just init`** -\u003e Init the `build` folder with the pinned\n   [`reveal.js`](.gitmodules) source and inject some [changed files](src/mixin)\n   (styles, fonts, etc.) and install dependencies inside the build folder.\n\n2. **`just watch`** -\u003e Watch the files in [`src`](src/) and synchronize changes\n   to the `build` folder. This is needed to continuously update your changes\n   source files and make the browser reload the page.\n\n3. **`just present`** -\u003e Serve the presentation in the browser and continuously\n   reload the page.\n\n4. **`just package`** -\u003e Export the presentation as HTML and PDF inside a `.zip`\n   file to the [`publish`](publish) folder.\n\n5. **`just publish`** -\u003e Build and upload the (selected) presentation to the\n   `publish` **branch** in the folder `docs/gh-pages` which can then be served\n   by Github pages. The\n   [`.publish.yaml`](./src/presentations/presentation-1/.publish.yaml) helps in\n   defining the name and output folder in `docs/gh-pages` to host multiple\n   presentations alongside.\n\n## Make a Presentation\n\n- Write your presentation in Markdown in\n  [`src/presentations`](src/presentations). All images and other assets needed\n  by the presentation should go into the respective `assets` directory (e.g.\n  [`presentation-1/assets`](/src/presentations/presentation-1/assets))\n\n## Resources\n\nCheck the following resources with additional slide materials:\n\n- [Documentation](https://revealjs.com/)\n- [Markdown from a C++ presentation](https://github.com/gabyx/tech-pr-cpp-value-catergories/blob/main/files/cpp-meeting/Vortrag.md)\n  [View](https://gabyx.github.io/tech-pr-cpp-value-catergories)\n\n## Modifications\n\n- Edit the design in [`company.scss`](css/theme/source/company.scss).\n\n- Company Logo: Edit the file\n  [`company-logo.svg`](css/theme/source/files/company-logo.svg).\n\n  - Replace embedded image in [`company.scss`](css/theme/source/company.scss)\n    with\n\n  ```shell\n  just bake-logo\n  ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdsc-ordes%2Ftechnical-presentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsdsc-ordes%2Ftechnical-presentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsdsc-ordes%2Ftechnical-presentation/lists"}