{"id":23980842,"url":"https://github.com/fourkitchens/readmes","last_synced_at":"2026-03-02T15:35:24.308Z","repository":{"id":51763454,"uuid":"102521186","full_name":"fourkitchens/readmes","owner":"fourkitchens","description":"default readme pieces","archived":false,"fork":false,"pushed_at":"2021-05-10T05:20:40.000Z","size":56,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-01-07T10:20:01.227Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/fourkitchens.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}},"created_at":"2017-09-05T19:23:31.000Z","updated_at":"2019-09-06T15:47:20.000Z","dependencies_parsed_at":"2022-08-22T17:50:47.056Z","dependency_job_id":null,"html_url":"https://github.com/fourkitchens/readmes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Freadmes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Freadmes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Freadmes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Freadmes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fourkitchens","download_url":"https://codeload.github.com/fourkitchens/readmes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240564599,"owners_count":19821422,"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-01-07T10:18:57.045Z","updated_at":"2025-11-17T15:03:12.538Z","avatar_url":"https://github.com/fourkitchens.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Four Kitchen General Purpose Readme Sections\n\nThis respository houses the basic layout of readmes on a 4K project. One can use this framework and the following examples to *build* readmes in their project using node so that the documentation only has to be updated in a single place.\n\n## Repository Structure\n\nThe structure of this repository is roughly layed out in [Hosting]/[Framework]/[Build Type].\n\n**Hosting** is they type of hosting. It consists of typically Pantheon, Acquia, and Custom.\n\n**Framework** is the type of project. Example, D7, D8, or Wordpress.\n\n**Build Type** is based on the build architecture. Typically this is identified as something like Composer, Aquifer, Drush Make, or Manual.\n\nIt is possible for a Hosting/Framework/Build Type combination to share documentation between each. In those situations, simply place it in the most common denomination of commonality like [Hosting]/[Framework] or [Hosting]. In other cases, symlink to the correct documentation piece.\n\nIf documentation applies to all instances, feel free to add it to the `global` folder at the hosting level.\n\n## How To Use\n\nIn your existing project, you will need to add an .emdaer.yml file. You will also need to add emdaer and this readmes document as a dependency. You can then run emdaer as a command any time you wish to update your documentation. An example follows.\n\n### package.json\n```\n{\n  \"name\": \"emdaer-test\",\n  \"description\": \"\",\n  \"scripts\": {\n    \"emdaer\": \"emdaer\"\n  },\n  \"devDependencies\": {\n    \"emdaer\": \"^0.3.3\",\n    \"readmes\": \"git+ssh://git@github.com:fourkitchens/readmes.git\"\n  }\n}\n```\n\n### .emdaer.yml\n```\n- text: '# Manual Pantheon Project'\n- text: \"This is a brief overview of my manual Pantheon Project located at https://github.com/fourkitchens/readmes/tree/master/pantheon/d7/manual\"\n- include: './node_modules/readmes/pantheon/d7/manual/at-a-glance.md'\n- include: './node_modules/readmes/pantheon/d7/manual/brief-foundation-architecture.md'\n- include: './node_modules/readmes/pantheon/d7/manual/before-you-start.md'\n- include: './node_modules/readmes/global/getting-started.md'\n- include: './node_modules/readmes/global/subsequent-builds.md'\n- include: './node_modules/readmes/global/git-workflow.md'\n- include: './node_modules/readmes/global/prs.md'\n- include: './node_modules/readmes/global/commits.md'\n- include: './node_modules/readmes/pantheon/d7/manual/configuration-management-workflow.md'\n- include: './node_modules/readmes/pantheon/d7/manual/deployment.md'\n- include: './node_modules/readmes/global/testing.md'\n- include: './node_modules/readmes/global/known-issues.md'\n```\n\n### Edits:\nIf you need custom edits to your readme, create a docs directory and change `node_modules/readmes/pantheon/d7/manual` to `docs` in the `.emdaer.yml` file.\n\nRun:\n```\nnpm install\nnpm run emdaer\n```\nYou will have a rendered version of the Manual Pantheon Project. You can see this example in https://github.com/fourkitchens/readmes/tree/master/examples/pantheon-d7-manual.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Freadmes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffourkitchens%2Freadmes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Freadmes/lists"}