{"id":15527225,"url":"https://github.com/grahamedgecombe/ignition","last_synced_at":"2025-04-23T12:25:55.508Z","repository":{"id":56877320,"uuid":"961396","full_name":"grahamedgecombe/ignition","owner":"grahamedgecombe","description":"Static pages for Rails 4.","archived":false,"fork":false,"pushed_at":"2014-04-12T19:20:00.000Z","size":310,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-15T18:52:25.674Z","etag":null,"topics":["rails","ruby"],"latest_commit_sha":null,"homepage":"http://grahamedgecombe.com/projects/ignition","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grahamedgecombe.png","metadata":{"files":{"readme":"README.markdown","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}},"created_at":"2010-10-04T18:40:12.000Z","updated_at":"2014-04-12T19:20:02.000Z","dependencies_parsed_at":"2022-08-20T23:10:09.432Z","dependency_job_id":null,"html_url":"https://github.com/grahamedgecombe/ignition","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grahamedgecombe%2Fignition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grahamedgecombe%2Fignition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grahamedgecombe%2Fignition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grahamedgecombe%2Fignition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grahamedgecombe","download_url":"https://codeload.github.com/grahamedgecombe/ignition/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250432440,"owners_count":21429671,"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":["rails","ruby"],"created_at":"2024-10-02T11:05:07.955Z","updated_at":"2025-04-23T12:25:55.475Z","avatar_url":"https://github.com/grahamedgecombe.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Ignition\n========\n\nIgnition is a [Rails][1] [engine][2] which routes and renders your\napplication's static pages.\n\nInstallation\n------------\n\nIt takes three easy steps to install Ignition:\n\n  1. Add `gem 'ignition'` to your `Gemfile` and run the `bundle` command.\n\n  2. Mount Ignition's engine in your `config/routes.rb` file:\n\n         mount Ignition::Engine =\u003e '/pages'\n\n  3. Create pages like normal templates in the `app/views/pages` directory. Use\n     any format and template handler you like. They'll be available at\n     `/pages/name`.\n\nFeatures\n--------\n\n  * Caching\n\n  * Secure - users cannot fetch pages outside of the `app/views/pages` directory\n\n  * Nested pages - e.g. `http://my.app/pages/projects/hello` would load the\n    template `app/views/projects/hello.html.erb`\n\n  * Mountable at any path - e.g. you could mount to `/` if you wanted pages\n    like `/about`, this will not conflict with your existing routes even if\n    Ignition is mounted before you define the routes\n\n  * URL helpers - use `ignition_engine.page_path` and\n    `ignition_engine.page_url` to link to your static pages.\n\n  * Works with custom (and multiple) `app/views` paths.\n\nConfiguration\n-------------\n\n### Caching\n\nBy default Ignition does not perform any caching, as this can interfere with\nthe application's layout if it is dynamic.\n\nThere are three types of caching:\n\n  * **`:none`** - does not perform any caching (default).\n\n  * **`:page`** - caches the entire page using Rails' [page caching][3]. As page\n    caching was removed form Rails 4, you'll need to install the\n    `actionpack-page_caching` gem for this option to work.\n\n  * **`:page_without_layout`** - caches the page using Rails'\n    [action caching][4]. The layout is not included in the cache, therefore\n    this option is suitable if your layout is dynamic. However, it's probably\n    also not very useful, unless you do some long-running computation in your\n    static page templates. As action caching was removed from Rails 4, you'll\n    need to install the `actionpack-action_caching` gem for this option to work.\n\nThese can be set in the `config/application.rb` file or any of the\n`config/environments/*.rb` files, like so:\n\n    config.ignition.cache = :page\n\n### Layout\n\nBy default Ignition will make your static pages use the `application` layout.\nThis is also the Rails default. It can be changed like so in the\n`config/application.rb` file:\n\n    config.ignition.layout = 'my_page_layout'\n\n### View Prefix\n\nBy default Ignition will try to include pages in a folder named `pages` inside\nyour `app/views` folder. You can change this `pages` prefix by changing the\nfollowing setting inside the `config/application.rb` file:\n\n    config.ignition.view_prefix = 'static_pages'\n\nThe only reason you would probably want to do this is if `pages` conflicts with\na controller and set of views you already have.\n\nTips\n----\n\n### Avoid typing `ignition_engine.` in front of URL helpers\n\nThis can be accomplished by placing the following code in your\n`ApplicationHelper` module, found in the `app/helpers/application_helper.rb`\nfile:\n\n    [:page_path, :page_url].each do |method|\n      define_method(method) do |*args|\n        ignition_engine.send(method, *args)\n      end\n    end\n\nLicense\n-------\n\nIgnition is available under the MIT license, see the `LICENSE` file.\n\n[1]: http://www.rubyonrails.org\n[2]: http://api.rubyonrails.org/classes/Rails/Engine.html\n[3]: http://guides.rubyonrails.org/caching_with_rails.html#page-caching\n[4]: http://guides.rubyonrails.org/caching_with_rails.html#action-caching\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrahamedgecombe%2Fignition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrahamedgecombe%2Fignition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrahamedgecombe%2Fignition/lists"}