forked from cburgdorf/grunt-html-snapshot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpackage.json
40 lines (40 loc) · 3.49 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"name": "grunt-html-snapshot",
"version": "0.2.3",
"description": "A grunt task that fetches html snapshots of your web app for easier SEO",
"author": {
"name": "Christoph Burgdorf",
"email": "[email protected]",
"url": "http://cburgdorf.wordpress.com"
},
"main": "Gruntfile.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "https://github.com/cburgdorf/grunt-html-snapshot.git"
},
"licenses": [
{
"type": "MIT",
"url": "https://github.com/cburgdorf/grunt-html-snapshot/blob/master/LICENSE-MIT"
}
],
"engines": {
"node": ">= 0.8.0"
},
"dependencies": {
"grunt-lib-phantomjs": "0.3.0"
},
"keywords": [
"SEO",
"html",
"snapshots",
"gruntplugin"
],
"readme": "# grunt-html-snapshot\n\n> Makes it easy to provide html snapshots for client side applications so that they can be indexed by web crawlers\n\n\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-html-snapshot --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-html-snapshot');\n```\n\n\n## htmlSnapshot task\n_Run this task with the `grunt htmlSnapshot` command._\n\n## configuring the htmlSnapshot task\n\n```js\n grunt.initConfig({\n htmlSnapshot: {\n all: {\n options: {\n //that's the path where the snapshots should be placed\n //it's empty by default which means they will go into the directory\n //where your Gruntfile.js is placed\n snapshotPath: 'snapshots/',\n //This should be either the base path to your index.html file\n //or your base URL. Currently the task does not use it's own\n //webserver. So if your site needs a webserver to be fully\n //functional configure it here.\n sitePath: 'http://localhost:8888/my-website/',\n //you can choose a prefix for your snapshots\n //by default it's 'snapshot_'\n fileNamePrefix: 'sp_',\n //by default the task waits 500ms before fetching the html.\n //this is to give the page enough time to to assemble itself.\n //if your page needs more time, tweak here.\n msWaitForPages: 1000,\n //if you would rather not keep the script tags in the html snapshots\n //set `removeScripts` to true. It's false by default\n removeScripts: true,\n //he goes the list of all urls that should be fetched\n urls: [\n '',\n '#!/en-gb/showcase'\n ]\n }\n }\n }\n });\n```\n\n## Release History\n\n- 0.2.1 - fixed a bug where quotes where missing from the html\n- 0.2.0 - added option to remove script tags from the output\n- 0.1.0 - Initial release\n",
"readmeFilename": "README.md",
"_id": "[email protected]",
"_from": "grunt-html-snapshot@*"
}