{"id":25254234,"url":"https://github.com/alchemycms/alchemy-usermanual","last_synced_at":"2025-10-27T01:30:57.944Z","repository":{"id":12599122,"uuid":"15270038","full_name":"AlchemyCMS/alchemy-usermanual","owner":"AlchemyCMS","description":"User manual module to your alchemy cms driven application.","archived":false,"fork":false,"pushed_at":"2016-05-31T09:36:50.000Z","size":55,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-21T04:10:55.473Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/AlchemyCMS.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}},"created_at":"2013-12-18T00:40:15.000Z","updated_at":"2020-02-21T22:58:20.000Z","dependencies_parsed_at":"2022-09-09T06:51:29.890Z","dependency_job_id":null,"html_url":"https://github.com/AlchemyCMS/alchemy-usermanual","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-usermanual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-usermanual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-usermanual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-usermanual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlchemyCMS","download_url":"https://codeload.github.com/AlchemyCMS/alchemy-usermanual/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238418222,"owners_count":19468866,"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-02-12T05:31:23.151Z","updated_at":"2025-10-27T01:30:57.523Z","avatar_url":"https://github.com/AlchemyCMS.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## On-site user manual for Alchemy CMS\n\n[![Build Status](https://secure.travis-ci.org/AlchemyCMS/alchemy-usermanual.svg)](http://travis-ci.org/AlchemyCMS/alchemy-usermanual)\n[![Test Coverage](https://codeclimate.com/github/AlchemyCMS/alchemy-usermanual/badges/coverage.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-usermanual/coverage)\n[![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-usermanual/badges/gpa.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-usermanual)\n\nThe version 1.x is used to work with [Alchemy CMS 3.x](https://github.com/AlchemyCMS/alchemy_cms/tree/master)\n\nThe alchemy-usermanual gem reads your `page_layouts.yml` and `elements.yml` and wraps all the interesting stuff into a module rendered in the admin-frontend of your Alchemy CMS driven application.\n\nUsers that are logged in to Alchemy can read through the self-explaining website configuration.\n\n## Installation\n\nAdd this line to your application's `Gemfile`:\n\n~~~\ngem 'alchemy-usermanual', '~\u003e 1.0'\n~~~\n\nAnd then run `bundle install` on your terminal.\n\n\n## Usage\n\nYou just need to bundle the gem with your application. Then the user manual will be available in the Alchemy admin-frontend.\n\nBy default translated informations of your page_layouts and elements are presented to the user.\nIf you like to extend these informations with individual descriptions, you can store these translatable informations as *hints* in your `page_layouts.yml` and `elements.yml` files.\n\n*Example 1 (hint for a page_layout)*\n\n~~~\n# /config/alchemy/page_layouts.yml\n- name: product_detail\n  hint: true\n  elements: [...]\n\n# /config/locales/en.yml\nen:\n  alchemy:\n    page_layout_hints:\n      product_detail: \"This page template is used for presenting all the details of one certain product... You can write a full description of what the page template is used to and what the user should consider when using it.\"\n~~~\n\n*Example 2 (hint for an element)*\n\n~~~\n# /config/alchemy/elements.yml\n- name: product_detail\n  hint: true\n  elements: [...]\n\n# /config/locales/en.yml\nen:\n  alchemy:\n    element_hints:\n      product_video: \"This element is used to play the youtube video of your product... You can write a full description of what the element is used to and what the user should consider when using it.\"\n~~~\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falchemycms%2Falchemy-usermanual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falchemycms%2Falchemy-usermanual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falchemycms%2Falchemy-usermanual/lists"}