{"id":15711732,"url":"https://github.com/jacksteamdev/plop-md","last_synced_at":"2026-02-14T20:35:55.544Z","repository":{"id":144037133,"uuid":"246337574","full_name":"jacksteamdev/plop-md","owner":"jacksteamdev","description":"Use a markdown file to tell PlopJS how to setup your project. Plop dozens of files at once.","archived":false,"fork":false,"pushed_at":"2023-08-03T06:19:40.000Z","size":543,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-08T09:29:38.932Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jacksteamdev.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":"2020-03-10T15:26:14.000Z","updated_at":"2020-06-03T21:28:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"834a1245-d997-4b5f-9f52-f323a745092a","html_url":"https://github.com/jacksteamdev/plop-md","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/jacksteamdev/plop-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksteamdev%2Fplop-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksteamdev%2Fplop-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksteamdev%2Fplop-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksteamdev%2Fplop-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacksteamdev","download_url":"https://codeload.github.com/jacksteamdev/plop-md/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacksteamdev%2Fplop-md/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29455360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T15:52:44.973Z","status":"ssl_error","status_checked_at":"2026-02-14T15:52:11.208Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-10-03T21:13:49.166Z","updated_at":"2026-02-14T20:35:55.523Z","avatar_url":"https://github.com/jacksteamdev.png","language":"TypeScript","readme":"# `@bumble/plop-md`\n\nUse a markdown file to tell PlopJS how to setup your project. Plop dozens of\nfiles at once.\n\n## Syntax\n\nPlopMD first creates an `ELEMENTS.md` file using the available generators. You\nthen fill out the elements file with comments, code blocks, and lists. Then run\n`plop md` again to generate the files for a that project.\n\n### Headings\n\nThe elements file sections are defined by Headings. Each level has a different\nmeaning.\n\n- H1: Section titles. These headings are for organization, and are ignored by\n  the parser.\n- H2: Generator names. Each H2 should correspond to an available Plop generator.\n- H3: File names. The text content under an H3 will become the value of\n  `filename` in the Plop generator. Code blocks, lists, and regular paragraphs\n  are supported.\n\n### Other elements\n\n- Code blocks, lists and plain text content at the generator level are added to\n  the top of each file in order.\n- Code blocks, lists and plain text content at the file level are inserted after\n  generator level content, and in order of appearance.\n- Lists and plain text are inserted as multiline comment blocks.\n- Code blocks are inserted as inline code.\n  \u003c!-- TODO: parse data blocks - Custom template variables can be defined at the generator or file level inside\n    code blocks with `plop` as the language. `plop` blocks should be either YAML\n    or JSON format. Multiple `plop` blocks in one file are assigned using\n    `Object.assign` from the top down, with subsequent values overwriting previous\n    values. --\u003e\n\n### Invalid syntax\n\n- If a generator (## heading) does not match an available generator, the\n  operation will throw.\n- If a generator does not match a section, that generator is ignored.\n- If a generator section has no files but has some content, it is parsed as a\n  file with the generator name.\n- If a file (### heading) is not under a generator section, the operation will\n  throw.\n- Any content not under a generator (## heading) is ignored.\n  \u003c!-- TODO: support prompts - If a generator requires specific values, it should include prompts. --\u003e\n\n\u003c!-- TODO: add project init --\u003e\n\u003c!-- This generator initializes the project, first checking the `package.json` file\nfor name, version, and description, then prompting and updating it if those\nfields are missing. --\u003e\n\n### Example `ELEMENTS.md` file\n\nA PlopMD elements file looks something like this:\n\n```md\n# ELEMENTS for Sample Project\n\n## Generator\n\n\u003c!-- Add comments and code blocks for each generator file here. --\u003e\n\n### `example file name`\n\n\u003c!-- Add comments and code blocks for this file here. --\u003e\n```\n\n### Plopfile Usage\n\n```javascript\n// plopfile.js\n\nmodule.exports = (plop) =\u003e {\n  plop.load('plop-md/load.js')\n}\n```\n\n### Data provided\n\n```typescript\ninterface PlopMdData {\n  /** Full ELEMENTS.md as MD instance */\n  md: MD\n  /** Name of file, or H3 */\n  filename: string\n  /** Section as MD instance */\n  section: MD\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacksteamdev%2Fplop-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacksteamdev%2Fplop-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacksteamdev%2Fplop-md/lists"}