{"id":18763136,"url":"https://github.com/simre1/missing-semester-project","last_synced_at":"2025-12-05T22:30:15.001Z","repository":{"id":222624510,"uuid":"757923195","full_name":"Simre1/missing-semester-project","owner":"Simre1","description":"MarkDownie's PDF Party is an easy to use Markdown to PDF converter that brightens up your day 🎉","archived":false,"fork":false,"pushed_at":"2024-04-04T18:38:08.000Z","size":249,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-29T05:22:21.070Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Simre1.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-02-15T09:11:44.000Z","updated_at":"2024-04-04T17:28:22.000Z","dependencies_parsed_at":"2024-02-15T10:30:15.304Z","dependency_job_id":"a4f5b0c4-06fa-46f2-a21b-2e12bde7c551","html_url":"https://github.com/Simre1/missing-semester-project","commit_stats":null,"previous_names":["simre1/missing-semester-project"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simre1%2Fmissing-semester-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simre1%2Fmissing-semester-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simre1%2Fmissing-semester-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Simre1%2Fmissing-semester-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Simre1","download_url":"https://codeload.github.com/Simre1/missing-semester-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239661789,"owners_count":19676409,"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-07T18:24:50.261Z","updated_at":"2025-12-05T22:30:14.942Z","avatar_url":"https://github.com/Simre1.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkDownie's PDF Party\n\nWelcome to MarkDownie's PDF Party - your easy to use Markdown to PDF converter.\n\n## Frontend\n![image](https://github.com/Simre1/missing-semester-project/assets/23276756/25ccfbd4-e228-4ff4-9e48-fa68eaf4c970)\n\nTo convert Markdown encoded text into a PDF, \ntype or paste it into the editor on the left. \nPress then compile button (the one with the error in the center) to create a PDF out of the text, \nwhich gets then displayed on the right. \nAs a special service, everytime you compile, \na (harmless) surprise will happen to brighten up your day. 🎉🥳\n\nOn case custom styling is wanted, by using the pencil button (the one left to the compile button) a second editor for CSS input can be opened.\nCSS styles need to target HTML elements, like `h1` or `p`.\n\n### Used technology\nThe project is based on Svelte for the frontend and SvelteKit for the backend.\n\n### Fonts\nWe used fonts available from Google Fonts (Inter, Londrina Shadow, and the Material Symbols), \nbut we embedded them in our project, so that Google Servers are not called.\nIn the Acknowledgement section of our project, the Material Symbols are mentioned,\nas the other fonts use \n[the SIL Open Font License (OFL) license](https://openfontlicense.org),\nfor which acknowledgements are not necessary.\n\n## Backend\n\nSend a POST request with the markdown content to `/api` to get a pdf back.\n\n## Starting\n\nOnce you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:\n\n```bash\nnpm run dev\n\n# or start the server and open the app in a new browser tab\nnpm run dev -- --open\n```\n\n## Building\n\nTo create a production version of your app:\n\n```bash\nnpm run build\n```\n\nYou can preview the production build with `npm run preview` or start it in production with `node build/index.js`. If you are having issues with PhantomJS when running `node build/index.js`, use `OPENSSL_CONF=/dev/null node build/index.js`!\n\n\n## Installation\n\nTo enable easy usage and installation MarkDownie's PDF Party is available as a Docker container. \n\nJust pull the container from `ghcr.io/simre1/missing-semester-project:release` and expose port 3000 to your network.\n\n\n# Acknowledgment\nFor the creation of MarkDownie's PDF Party, we entered the JavaScript Hell (although relying on TypeScript as well) and use a number open-source projects as listed below:\n\n - md-to-pdf\n   The MIT License (MIT)\n\n   Copyright (c) 2024 Simon Hänisch\n\n   Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\n   The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n   THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\n\n - Material Symbols\n   Copyright 2024 Google\n\n   Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n   Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the \n   specific language governing permissions and limitations under the License.\n\n - Monaco Editor\n   The MIT License (MIT)\n\n   Copyright (c) 2016 - present Microsoft Corporation\n\n   Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to \nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\n   The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n   THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR \n   COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\n\n - Svelte\n   The MIT License (MIT)\n\n   Copyright (c) 2016 - 2024 the contributors of the repository at https://github.com/sveltejs/svelte\n\n   Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\n   The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n   THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\n\n - tsParticles\n   The MIT License (MIT)\n\n   Copyright (c) 2020 Matteo Bruni\n\n   Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\n   The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\n   THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimre1%2Fmissing-semester-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimre1%2Fmissing-semester-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimre1%2Fmissing-semester-project/lists"}