{"_id":"nodejitsu-handbook","_rev":"46-bd2160516f86f770c0133a31833bf193","name":"nodejitsu-handbook","time":{"modified":"2022-06-22T02:17:28.407Z","created":"2014-01-31T11:29:02.250Z","0.5.1":"2014-01-31T11:29:02.250Z","0.6.0":"2014-02-24T19:16:55.370Z","0.6.1":"2014-02-24T22:48:23.682Z","0.6.2":"2014-02-25T13:06:21.176Z","0.6.3":"2014-03-12T14:27:34.078Z","0.6.4":"2014-04-01T07:02:21.746Z","0.7.0":"2014-05-19T14:52:39.700Z","0.7.1":"2014-05-22T15:16:04.613Z","0.7.2":"2014-06-10T18:16:11.019Z","0.7.3":"2014-08-21T11:45:13.876Z","0.7.4":"2014-08-21T12:13:10.104Z","0.7.5":"2014-08-26T15:21:00.221Z","0.7.6":"2015-02-24T18:02:05.887Z","0.7.7":"2015-02-24T18:26:30.996Z","0.8.0":"2015-09-02T06:49:41.290Z"},"maintainers":[{"email":"info@martijnswaagman.nl","name":"swaagie"},{"email":"jcrugzz@gmail.com","name":"jcrugzz"},{"email":"charlie.robbins@gmail.com","name":"indexzero"},{"email":"npm@3rd-Eden.com","name":"v1"},{"email":"npm@3rd-Eden.com","name":"3rdeden"}],"dist-tags":{"latest":"0.8.0"},"description":"A gentle introduction to the art of nodejitsu","readme":"[status]: https://webhooks.nodejitsu.com/nodejitsu/handbook.png\n\n# The Nodejitsu Handbook\n\n**You can view the Handbook online at https://www.nodejitsu.com/documentation**\n\nWelcome to the Nodejitsu handbook. This document will help familiarize you with \ndeploying your Node.js applications to the cloud while also providing detailed \ninformation about Nodejitsu's platform-specific features and about where to get \nhelp when you need it.\n\nThis is a living document which you can submit patches to at\n[http://github.com/nodejitsu/handbook][repo].\nHandbook content resides in [/content][content] and is easily accessed by using\nseveral methods of [/index.js][handbook],\n\n[repo]: http://github.com/nodejitsu/handbook\n[content]: https://github.com/nodejitsu/handbook/tree/master/content\n[handbook]: https://github.com/nodejitsu/handbook/blob/master/index.js\n\n## Adding content\nWriting a new article is done by simply adding a Markdown file to a subdirectory.\nSeveral articles with related content can be placed under a seperate/new\nsubdirectory. Only markdown files included in the catalog. \n\nNote: each subdirectory is expected to at least have an index.md to generate a\nproper catalog.\n\n## Moving around content\nWhen you want to move content or complete folders you should update the\n`301.json` file that is in the root of the git repository. This way implementors\ncan redirect urls easily without getting 404's. If you are removing content you\ndon't need to change anything as it's supposed to 404.\n\n## Images\nImages must be added to [/resource][resource]. Our [CDN][cdn] will ensure \nimages are fetched from the repository and properly cached. Linking to an \nimage from the article should be done as below:\n\n```\n![no applications](https://versions.nodejitsu.com/id:handbook/resources/noapps.png)\n```\n\n[resource]: https://github.com/nodejitsu/handbook/tree/master/resource\n[cdn]: http://versions.nodejitsu.com\n\n## Using the handbook as module\nSimply add handbook as dependency to the package.json, make sure to call the\nhandbook constructor, otherwise the [search index][lunr] will not be initialized\nproperly.\n\n``` javascript\nvar Handbook = require('handbook'),\n    documentation = new Handbook();\n\ndocumentation.search('query');\n```\n\n[lunr]: #lunr-search \n\n### Get markdown content\nCall `handbook.get('/a-quickstart/hello-world')` with a relative path to the\narticle as first parameter, adding `.md` is optional.\n\nwill return an object with keys content, description, title and tags. For more\ndetails about data for all keys, see [Description, title and tags][description].\n\n``` javascript\n{\n  content: '##Some markdown content\\n\\nWhich is not parsed yet.',\n  description: 'description parsed from content',\n  title: 'title parsed from content',\n  tags: [\n    'top', 'ten', 'unique', 'descriptive', 'words', \n    'without', 'numbers', 'and', 'short', 'tags'\n  ] \n}\n```\n\n[description]: #description-title-and-tags \n\n### Get the catalog\nCall `handbook.catalog()` to aquire a complete catalog from content\n(sychronously), which should return an object with paths, href's, titles and\ndescriptions. If you want to generate the catalog asynchronously then supply a\ncallback to the function.\n\n``` javascript\n{ \n  index: { \n    index: { \n      href: '',\n      title: 'Handbook',\n      description: '# Introduction\\n\\nWelcome to the Nodejitsu handbook. This document will help familiarize you with\\ndeploying your Node.js applications to the cloud while also providing detailed\\ninformation about Nodejitsu\\'s platform-specific features and about\\nwhere to get help when you need it.',\n      path: '/var/www/nodejitsu/handbook/content' \n    } \n  },\n  support: { \n    index: { \n      href: '/support',\n      title: 'Need Support?',\n      description: '# Need Support?\\n\\nNodejitsu has a team of developers standing by to assist users with any issues\\nthey may come across while deploying and administrating their web applications\\non the Nodejitsu platform. Nodejitsu strives to have a lightning-fast turnaround\\non all issues you may have!',\n      path: '/var/www/nodejitsu/handbook/content/support' \n    } \n  }\n}\n```\n\n### Description, title and tags\nAdding a description and title to the article is as easy as providing it at the\nbottom of the content as per example. Omitting title and/or description is\npossible. The description will be parsed from the first lines of the content.\nThe title will be returned with an empty string.\n\n``` markdown\n[meta:title]: <> (Using the jitsu CLI)\n[meta:description]: <> (Some nice description about the content of the article)\n```\n\nTags are parsed from the content by using Term Frequecy-Inverse Document\nFrequency. Ten of the most descriptive tags are returned by default. Currently,\nthere is no support for custom tags.\n\n### Lunr search\nHandbooks search engine is powered by [Lunr][github-lunr]. The handbook#search\nmethod is a simple proxy to Lunr search.\n\n[github-lunr]: https://github.com/olivernn/lunr.js \n","versions":{"0.7.4":{"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"name":"nodejitsu-handbook","description":"A gentle introduction to the art of nodejitsu","version":"0.7.4","subdomain":"handbook","homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"scripts":{"start":"bin/server"},"dependencies":{"natural":"0.1.x","lunr":"0.5.x"},"engines":{"node":"0.10.x"},"bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"_id":"nodejitsu-handbook@0.7.4","_shasum":"268499fbc875ece9c5eab7cdeb366029c5ee58ad","_from":".","_npmVersion":"1.4.10","_npmUser":{"name":"swaagie","email":"info@martijnswaagman.nl"},"maintainers":[{"name":"swaagie","email":"info@martijnswaagman.nl"}],"dist":{"shasum":"268499fbc875ece9c5eab7cdeb366029c5ee58ad","tarball":"https://registry.npmjs.org/nodejitsu-handbook/-/nodejitsu-handbook-0.7.4.tgz","integrity":"sha512-hsRjyiQuutt+TERdMr3cOXn5ou3brecKJZDKwpGErNbP/hT8A5IGC08N20o2gPhG6InadWmL8lxxwwpOccsh0w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICpCpt+k3R65a3rnY4R2BiEYHEieFpH9v7Adp5dOnzndAiA7OL0lqsN/pKUga9aqDrwgiafujJwH6AlHMG/xgM6Fpg=="}]}},"0.7.5":{"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"name":"nodejitsu-handbook","description":"A gentle introduction to the art of nodejitsu","version":"0.7.5","subdomain":"handbook","homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"scripts":{"start":"bin/server"},"dependencies":{"natural":"0.1.x","lunr":"0.5.x"},"engines":{"node":"0.10.x"},"gitHead":"ca5d9d7983fa13c0956162e64ff47a1cf3a7c171","bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"_id":"nodejitsu-handbook@0.7.5","_shasum":"1e2bc8a23aab92749b23f6848f54bcbbbd5261ed","_from":".","_npmVersion":"1.4.23","_npmUser":{"name":"jcrugzz","email":"jcrugzz@gmail.com"},"maintainers":[{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"V1","email":"info@3rd-Eden.com"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"},{"name":"indexzero","email":"charlie.robbins@gmail.com"}],"dist":{"shasum":"1e2bc8a23aab92749b23f6848f54bcbbbd5261ed","tarball":"https://registry.npmjs.org/nodejitsu-handbook/-/nodejitsu-handbook-0.7.5.tgz","integrity":"sha512-2ieOycrWo96ds20wh4Rz2EyJwub57WY8pS4OsXPNdU9Ca85Gbvy8iPSBJRh81pXec85GF9QXjNVsTpbN8Qsp9Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB5hcfgvby2S1aepxvV45FkhkfxPAu+8PVo37YCD6M6JAiEAvniNnao5PjqChIZ6Ro/r8EMFgOm9dn6x0/EVuYkrymg="}]}},"0.7.6":{"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"name":"nodejitsu-handbook","description":"A gentle introduction to the art of nodejitsu","version":"0.7.6","subdomain":"handbook","homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"scripts":{"start":"bin/server"},"dependencies":{"natural":"0.1.x","lunr":"0.5.x"},"engines":{"node":"0.10.x"},"gitHead":"807d457e99ae40d00e04920ca8330aac24467e1a","bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"_id":"nodejitsu-handbook@0.7.6","_shasum":"81ec00740913cff23f42c85fd8aa847cebef5267","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"swaagie","email":"info@martijnswaagman.nl"},"maintainers":[{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"v1","email":"info@3rd-Eden.com"},{"name":"3rdeden","email":"npm@3rd-Eden.com"}],"dist":{"shasum":"81ec00740913cff23f42c85fd8aa847cebef5267","tarball":"https://registry.npmjs.org/nodejitsu-handbook/-/nodejitsu-handbook-0.7.6.tgz","integrity":"sha512-pX2KqK3qrtZf+zIEBeU1fWAEgOgN6uWCeqUq3OllmQSuN9jr3jmCjMlVjIawFuxaeLUGh6g86+r70OMDoCTULg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEMCIGSJydliBgTw09CXBsgHsMkKAl1rCXs3w4CIoGy8G8ypAh8zoq1oJ55WRz/18ZoolDTaJHwt2HQVbn8dmkbOj63F"}]}},"0.7.7":{"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"name":"nodejitsu-handbook","description":"A gentle introduction to the art of nodejitsu","version":"0.7.7","subdomain":"handbook","homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"scripts":{"start":"bin/server"},"dependencies":{"natural":"0.1.x","lunr":"0.5.x"},"engines":{"node":"0.10.x"},"gitHead":"fbdf19cf225b9eccad11841bfe192187f702f4ef","bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"_id":"nodejitsu-handbook@0.7.7","_shasum":"fecec25efbabe2d054e51d2862af7c5bd9c33d2f","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"swaagie","email":"info@martijnswaagman.nl"},"maintainers":[{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"v1","email":"info@3rd-Eden.com"},{"name":"3rdeden","email":"npm@3rd-Eden.com"}],"dist":{"shasum":"fecec25efbabe2d054e51d2862af7c5bd9c33d2f","tarball":"https://registry.npmjs.org/nodejitsu-handbook/-/nodejitsu-handbook-0.7.7.tgz","integrity":"sha512-YcA0X6sLQLOBSpwV0ERaKf6I6clN0x7R2VtQKi60JmudH8WxDvj3jQ/7EGI5mSRPsni25hQFL3AaMxY/x/8CFw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBNmEJqlbNhwx9phvC7hWUIqhaXwWfcoZ8Zm5pZqpUI0AiEA+ojZ8rX2IWQI4JXSXaxapie9wo11EI/qF23YJWhaX7g="}]}},"0.8.0":{"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"name":"nodejitsu-handbook","description":"A gentle introduction to the art of nodejitsu","version":"0.8.0","subdomain":"handbook","homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"scripts":{"start":"bin/server"},"dependencies":{"natural":"0.1.x","lunr":"0.5.x"},"engines":{"node":"0.10.x"},"gitHead":"b2f231a0a0bdf826e8c7835a8353aa31e3240438","bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"_id":"nodejitsu-handbook@0.8.0","_shasum":"b6e3af111055ff0d4e081d01db699637e6232c32","_from":".","_npmVersion":"2.14.1","_nodeVersion":"0.10.38","_npmUser":{"name":"indexzero","email":"charlie.robbins@gmail.com"},"maintainers":[{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"v1","email":"info@3rd-Eden.com"},{"name":"3rdeden","email":"npm@3rd-Eden.com"}],"dist":{"shasum":"b6e3af111055ff0d4e081d01db699637e6232c32","tarball":"https://registry.npmjs.org/nodejitsu-handbook/-/nodejitsu-handbook-0.8.0.tgz","integrity":"sha512-ULlgsAEvdI7Sn4H7pbqUAtQWLbcL4d8Ds9K+1WakCwOM1vRifN8aiylWJvwVSl8g9ac2qu+NLb1NzvOiFxxgGA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCL9GOyyid4YWcXVl8WHPm0AramrKYMTSnnu9mJaz5pxgIgdQLxwbntGB1BoyBez1+jYaZUMwQbbAHpHr8+SQUeAdY="}]}}},"homepage":"http://www.nodejitsu.com/docs","repository":{"type":"git","url":"git://github.com/nodejitsu/handbook.git"},"author":{"name":"Nodejitsu","email":"support@nodejitsu.com","url":"http://nodejitsu.com"},"bugs":{"url":"https://github.com/nodejitsu/handbook/issues"},"readmeFilename":"README.md"}