{"id":28381825,"url":"https://github.com/opf/md-to-pdf-upload-action","last_synced_at":"2025-06-25T04:31:17.087Z","repository":{"id":245861581,"uuid":"819376028","full_name":"opf/md-to-pdf-upload-action","owner":"opf","description":"Generate PDF by markdown and upload to Nextcloud","archived":false,"fork":false,"pushed_at":"2025-01-16T15:33:32.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-22T00:57:49.491Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opf.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-06-24T11:34:20.000Z","updated_at":"2025-01-16T15:24:17.000Z","dependencies_parsed_at":"2024-06-24T14:36:10.008Z","dependency_job_id":null,"html_url":"https://github.com/opf/md-to-pdf-upload-action","commit_stats":null,"previous_names":["opf/md-to-pdf-upload-action"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/opf/md-to-pdf-upload-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fmd-to-pdf-upload-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fmd-to-pdf-upload-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fmd-to-pdf-upload-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fmd-to-pdf-upload-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opf","download_url":"https://codeload.github.com/opf/md-to-pdf-upload-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opf%2Fmd-to-pdf-upload-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261805078,"owners_count":23212294,"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":"2025-05-30T04:06:31.991Z","updated_at":"2025-06-25T04:31:17.077Z","avatar_url":"https://github.com/opf.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# md-to-pdf-upload-action\n\n## Usage in your action\n\n### Installation\n\n```yml\n- name: Generate PDFs\n  uses: opf/md-to-pdf-upload-action@v1\n  with:\n    # md-to-pdf config file, relative to the root of the repository\n    config: \"./md-to-pdf.config.yml\" \n    # md-to-pdf styling folder, relative to the root of the repository\n    stylings: \"./styling/\" \n    # the nextcloud username for the upload\n    nextcloud-user: \"pdf-bot-user\"\n    # the nextcloud App key for the uploading user\n    nextcloud-app-access-key: \"the secret app key; do not place here, use github secrets\"\n    # the root folder on the nextcloud server where the files should be uploaded\n    nextcloud-upload-path: \"https://nextcloud.example.com/remote.php/dav/files/pdf-bot-user/some-example-path/upload-folder/\"\n```\n\n### Full example\n\n```yml\nname: Generate PDFs\n\non:\n  workflow_dispatch:\n\njobs:\n  generate:\n    runs-on: [ ubuntu-latest ]\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n        with:\n          ref: \"main\"\n\n      - name: Generate PDFs\n        uses: opf/md-to-pdf-upload-action@v1\n        with:\n          config: \"./md-to-pdf.config.yml\"\n          stylings: \"./styling/\" \n          nextcloud-user: ${{ secrets.NEXTCLOUD_USERNAME }}\n          nextcloud-app-access-key: ${{ secrets.NEXTCLOUD_APP_ACCESS_KEY }}\n          nextcloud-upload-path:  ${{ secrets.NEXTCLOUD_UPLOAD_PATH }}\n```\n\n# Howto\n\n* Create a stylings structure for md-to-pdf file in the your repository, \n  see [md-to-pdf styling](https://github.com/opf/md-to-pdf/blob/main/docs/STYLING.md)\n* Create a `md-to-pdf.config.yml` file in the your repository. \n\nIf you don't use the repository root folder, you need to configure the locations to the styling folder and the yml file in your action config. \n\n```yml\n  uses: opf/md-to-pdf-upload-action@v1\n  with:\n    config: \".github/md-to-pdf-example-path/md-to-pdf.config.yml\" # relative to the root of the repository\n    stylings: \".github/md-to-pdf-example-path/styling/\" # relative to the root of the repository\n```\n\n\u003e [!NOTE]\n\u003e All destination folders on Nextcloud must already exists, this action does not create folders. \n\u003e \n\u003e The action will overwrite existing files with the same name in the destination folder on Nextcloud. \n\u003e \n\u003e The action will not delete files in the destination folder on Nextcloud.\n\n\n# Generator configuration\n\n## Smallest configuration with all mandatory values\n\n```yml\n- documents:\n    - source: demo/demo.md\n      destination: demo-on-server/demo-file-on-server-1.pdf\n      styling: demo-styling\n```\n\n## Explained sample configuration\n\n```yml\n# you can create different groups, this is group 1\n- default: # default values for all documents in this group\n    styling: demo-styling # name of file in the stylings folder WITHOUT extension (optional if all stylings are set in documents)\n    pdf_language: de # optional, language to be used in the PDF (Hyphenation)\n    pdf_footer_3: Seite \u003cpage\u003e von \u003ctotal\u003e # optional, localized footer text\n  documents:\n    - source: demo/demo-de.md # mandatory, path to the markdown file, relative to the repository(!) root\n      destination: demo-path-on-server/de/demo-file-on-server-de.pdf # mandatory, path and filename to the destination on the server\n      styling: demo-styling # optional, overwrite default styling, if needed\n      pdf_footer: Demo-Datei Footer  # optional, set a footer text for this document\n\n# group 2 same as group 1 but with different language\n- default:\n    styling: demo-styling\n    pdf_language: en\n    pdf_footer_3: Page \u003cpage\u003e of \u003ctotal\u003e\n  documents:\n    - source: demo/demo-en.md\n      destination: demo-path-on-server/en/demo-file-on-server-en.pdf\n      pdf_footer: Demo File Footer\n\n# group 3 with default stylings value \n- default:\n    styling: demo-styling\n  documents:\n    - source: demo/demo-3.md\n      destination: demo-file-on-server-3.pdf\n    - source: demo/demo-4.md\n      destination: demo-file-on-server-4.pdf\n\n# group 4 without default values\n- documents:\n    - source: demo/demo-5.md\n      destination: demo-file-on-server-5.pdf\n      styling: demo-styling\n    - source: demo/demo-6.md\n      destination: demo-file-on-server-6.pdf\n      styling: demo-styling-2\n```\n\nFor values starting with `pdf_` see [md-to-pdf frontmatter](https://github.com/opf/md-to-pdf/blob/main/docs/FRONTMATTER.md) for available options.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopf%2Fmd-to-pdf-upload-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopf%2Fmd-to-pdf-upload-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopf%2Fmd-to-pdf-upload-action/lists"}