{"id":23378972,"url":"https://github.com/nvfp/ghact_auto_permalink","last_synced_at":"2025-04-08T05:49:31.778Z","repository":{"id":218509534,"uuid":"746575536","full_name":"nvfp/ghact_auto_permalink","owner":"nvfp","description":"GitHub action for making blog-like pages' permalink based on Jekyll project structure","archived":false,"fork":false,"pushed_at":"2024-01-22T10:33:53.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T03:55:02.222Z","etag":null,"topics":["ghaction","jekyll"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nvfp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-22T09:33:58.000Z","updated_at":"2024-01-22T09:34:53.000Z","dependencies_parsed_at":"2024-01-22T13:15:18.748Z","dependency_job_id":"c8a90956-8602-46e5-8f63-c2a013f6d9a9","html_url":"https://github.com/nvfp/ghact_auto_permalink","commit_stats":null,"previous_names":["nvfp/ghact_auto_permalink"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvfp%2Fghact_auto_permalink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvfp%2Fghact_auto_permalink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvfp%2Fghact_auto_permalink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvfp%2Fghact_auto_permalink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nvfp","download_url":"https://codeload.github.com/nvfp/ghact_auto_permalink/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247785927,"owners_count":20995644,"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":["ghaction","jekyll"],"created_at":"2024-12-21T19:15:48.973Z","updated_at":"2025-04-08T05:49:31.757Z","avatar_url":"https://github.com/nvfp.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"Make your blog-like pages' permalink automatically written during the build, which means we just need to specify the URL in the directory project structure, and the permalink will be based on that, which saves time!\n\nThe project structure should look like this:\n\n```txt\nroot/\n- foo/\n  - bar/\n    - 2020/\n      - 01-01-title_1/\n        - index.md\n        - img.jpg\n        - ...\n      - 01-01-title_2/\n        - index.md\n        - ...\n    - 2021/\n      - ...\n```\n\nLet's say this is a blog project, so each post has its own folder, `root/foo/bar/2020/01-01-title_1/` for example (let's call this \"container\"). So each post should have `index.md`, which contains the blog content itself. Inside each container, it can also contain images or anything needed for that specific post. Also, they will be grouped by years, so things are more maintainable for a long period project.\n\nNow let's open one of the containers:\n\n```markdown\n---\n# permalink:  # leave this empty because it will be written during the build process\n\n... # the rest of the file\n```\n\nSo, we just need to specify the commented `permalink` at line `2`, then during the build, we will be using:\n\n```yml\n- uses: nvfp/ghact_auto_permalink@a.b.c  # using the latest version OR main-branch is recommended\n  with:\n    where: ./foo/bar  # \"bar\" is the \"root\" for the blog-like pages\n    prefix: /blog/  # to make it \"/blog/title_1\", \"/blog/title_2\", etc.\n```\n\nNote: Please open the `action.yml` to learn more about the params.\n\nAnd that's it!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvfp%2Fghact_auto_permalink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnvfp%2Fghact_auto_permalink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvfp%2Fghact_auto_permalink/lists"}