{"_id":"gitbook2edx","_rev":"37-4d7019430a3bd702c54124813668a5bb","name":"gitbook2edx","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","dist-tags":{"latest":"0.2.1"},"versions":{"0.0.1":{"name":"gitbook2edx","version":"0.0.1","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0"},"_id":"gitbook2edx@0.0.1","dist":{"shasum":"79a172d7c8fd671111e1e424596de310dca3a8a2","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.1.tgz","integrity":"sha512-CW1FCeNaQpWUQ6AC0wLNi8f7o5IsvFf+H78msu7u4xmZEIkCSJVRQHJ/a1xjva0ERZh64WRLHCpAMiVl9+kNhw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHr0mJ24a17lh7/Qr5V5fRS3SV4Wo8jwxozbWPkcqZ7jAiApKA6rivBWAW4M983cBbh8vQmmF5GobnbHaYa6WEqZrA=="}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.2":{"name":"gitbook2edx","version":"0.0.2","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.2","dist":{"shasum":"1903a4b54838c3adea65eeeb238b8748c376a491","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.2.tgz","integrity":"sha512-EkWEywP84jpp6cfIben9uSTsvNcUG0tX7QT8jvZpmVmUzyCPzJAH8kRA2qjVPpiG0lnW+PZRl8CN/37dgqLEfA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCEUTMUeQKobVN8ul2L2qZbQMnT3wyPL0EJQQIsbNodEgIhAJ/NqZk0GtsQ6KLUCT65lonFmu4/rFmFBnhqFGaTVBXM"}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.3":{"name":"gitbook2edx","version":"0.0.3","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./scripts/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.3","dist":{"shasum":"63f5b98d40535815a1370920f22f9e995d41d74a","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.3.tgz","integrity":"sha512-sF3uyUnjuOs0Ti89a9s301AQynpXMPeG4zjPees/EjNImMiYkxiYWReVNkewlwkSbhGzhoOHONhZbLVV4DND9w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH4YRBgZoQbrYEHQeAUfJ8LGgvt4BT/YaUB1bz4Q+ElXAiEAwx5LnVYgMPi9YIPAYkPLK5DoHPFtTNIthEPLONJN2lA="}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.4":{"name":"gitbook2edx","version":"0.0.4","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./scripts/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.4","dist":{"shasum":"fa83ba7fc6d84f0d0742225146ce7393abeb42b6","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.4.tgz","integrity":"sha512-4m7LhTrt/12JtpykjTbbTKAClxu0Pu770DP4fpzuGHbyUphj1Dx3F7vkfStCTKUKPS5E/8X7lKwnfCpmmZUCrw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIELYnLhn5hVecoqVQ3tmV+N7PFB/HpCOb/C3R8DvaPxLAiAyryq0OMNvpTJNLLWdEaDcCaXNLqe7q5SOHYKcfaHmBA=="}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.5":{"name":"gitbook2edx","version":"0.0.5","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./scripts/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.5","dist":{"shasum":"ed830048e93cb91511dc53c53fabd2b88cbab40d","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.5.tgz","integrity":"sha512-MCvdGw0TuaEthgqcgSZWvgjxDga/4Mqv90kvkbVOalumOIRRXIcJh3MNIL2eRsoL8vVLqgjsjKJrURk9qeSD/g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBBgiWq9zmj8Ke/rrrulBnszqucPRkCZnxNd5K4KZLliAiEAtxmnDFrcymhvDdfAXFxbxXN0o2XyXJocCkIg9WJDHdc="}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.6":{"name":"gitbook2edx","version":"0.0.6","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./scripts/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.6","dist":{"shasum":"9ed496f511440d727486853afe3e7145f17e92d0","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.6.tgz","integrity":"sha512-v+iPKlub+GH/taC4q9T6x7EFIWQA4y2SoNGwtqicVS0w1jTf2yQJ82vPbrEKHvYBKxAAcVNyPxuHoHAqXtzHTw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFHPOlVw9x0s9bdOp15ztLrxGU4fTSJKb5PpuFMjeNZuAiEA4qOq3nBMO88wlYmZzmI1LLkQ5i35PU5DaUO/kILG8c4="}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.0.7":{"name":"gitbook2edx","version":"0.0.7","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./scripts/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"docopt":"~0.4.1","glob":"~4.3.1","bluebird":"~2.3.11","lodash":"~2.4.1","liquid-node":"~2.4.0","js-yaml":"~3.2.3","shelljs":"~0.3.0","debug":"~2.1.0","marked":"~0.3.2","date.js":"~0.2.0","moment":"~2.8.4","underscore.string":"~2.4.0","gitbook":"~1.4.2"},"_id":"gitbook2edx@0.0.7","dist":{"shasum":"49a1f8c758d14546000e32e91bcde95b284a822f","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.0.7.tgz","integrity":"sha512-9E6JzPh+YNDXY4jxlO3vqZrWJEGQ2Vjger0NE3FxP4KkhT7NzXehTlcbeu9bQMMWSp4ze/UhnIiYwU9bM7bXUg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC5EpTlO4lFoYfDaAGMCBQR9iwkP1ql6JdcdtoMuz7iXwIhAL/MpSoj54fVKhEhaoOjiXaqB2yJwyv0irjHWIB2ZwvI"}]},"_from":".","_npmVersion":"1.3.2","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}]},"0.1.0":{"name":"gitbook2edx","version":"0.1.0","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./test/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"base64-url":"^1.2.0","bluebird":"~2.3.11","chalk":"^0.5.1","cssify":"^0.6.0","date.js":"~0.2.0","debug":"~2.1.0","docopt":"~0.4.1","gitbook":"~1.4.2","glob":"~4.3.1","js-yaml":"~3.2.3","liquid-node":"~2.4.0","liveify":"^2.0.0","lodash":"~2.4.1","marked":"~0.3.2","moment":"~2.8.4","pretty-xml":"^1.0.3","shelljs":"~0.3.0","uid":"0.0.2","underscore.string":"~2.4.0","xyz":"^0.5.0"},"gitHead":"4ed2424136a399b24c95658c0ffa6f53841c52f0","_id":"gitbook2edx@0.1.0","_shasum":"c74dbd775c179a5d6203fdae514ba0c455eb2439","_from":".","_npmVersion":"1.4.23","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}],"dist":{"shasum":"c74dbd775c179a5d6203fdae514ba0c455eb2439","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.1.0.tgz","integrity":"sha512-gGAIh4FlCuyOUpf7SxGDmvm2nNgqUtu4Fjgh1f/8viETBJCE70Ch29ZnGhbYzNXbMs5K/n12fhVJwWW+7o40ww==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDgEu8YvAuNG470hoBpveExPj3Qx43OrhFX2zOE/Rh1BwIhAOsKYXkHFKqnTJUybPNyxoqBE9GZm8eyLSYTDhS4NPWY"}]}},"0.1.1":{"name":"gitbook2edx","version":"0.1.1","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"./test/test.sh"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"base64-url":"^1.2.0","bluebird":"~2.3.11","chalk":"^0.5.1","cssify":"^0.6.0","date.js":"~0.2.0","debug":"~2.1.0","diff-files":"^0.1.0","docopt":"~0.4.1","gitbook":"^1.5.0","glob":"~4.3.1","js-yaml":"~3.2.3","liquid-node":"~2.4.0","liveify":"^2.0.0","lodash":"~2.4.1","marked":"~0.3.2","moment":"~2.8.4","pretty-xml":"^1.0.3","shelljs":"~0.3.0","uid":"0.0.2","underscore.string":"~2.4.0","verb":"^0.6.2","verb-cli":"^0.4.6","xyz":"^0.5.0"},"gitHead":"27c50375876318dea285a1632de81ae0e39961fa","_id":"gitbook2edx@0.1.1","_shasum":"2df68f389c4a757d700cb1aaa8326e8e33dbf16a","_from":".","_npmVersion":"2.3.0","_nodeVersion":"0.11.16","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}],"dist":{"shasum":"2df68f389c4a757d700cb1aaa8326e8e33dbf16a","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.1.1.tgz","integrity":"sha512-MuBZBUmDNVA65GRaeh/pG56ZA/nqfejPVP8GChYrFATy7a1kAmtm2DWD9oDc6ZZsmEJ+T23/2VGBYrRKZYcdMw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDPAetiP+gs1qm/itpm2Tx0+nFQCqNEygOdyzIUyLa4AwIhAJFkBrENNVnjxPYd/7B0dADxLIS9jBAzucEGD9XKZ82J"}]}},"0.2.0":{"name":"gitbook2edx","version":"0.2.0","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"make test"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"babel":"^4.7.16","base64-url":"^1.2.0","bluebird":"~2.3.11","chalk":"^0.5.1","cssify":"^0.6.0","date.js":"~0.2.0","debug":"~2.1.0","diff-files":"^0.1.0","docopt":"~0.4.1","gitbook":"^1.5.0","glob":"~4.3.1","js-yaml":"~3.2.3","liquid-node":"~2.4.0","liveify":"^2.0.0","lodash":"~2.4.1","marked":"~0.3.2","mocha":"^2.2.1","moment":"~2.8.4","pretty-xml":"^1.0.3","shelljs":"~0.3.0","uid":"0.0.2","underscore.string":"~2.4.0","verb":"^0.6.2","verb-cli":"^0.4.6","xyz":"^0.5.0"},"devDependencies":{"chai":"^2.2.0","chai-as-promised":"^4.3.0","mocha":"^2.2.1"},"gitHead":"b8f0aa7c2b6edaa5709f9d6af18ddfe7e8f9adab","_id":"gitbook2edx@0.2.0","_shasum":"bdb2a9fb1b98067cd3719fafe4718872ca06d328","_from":".","_npmVersion":"2.3.0","_nodeVersion":"0.11.16","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}],"dist":{"shasum":"bdb2a9fb1b98067cd3719fafe4718872ca06d328","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.2.0.tgz","integrity":"sha512-nzZo/FhKOhyHOnmklIY8lBwDHj1aTZasOd3ycgqyH6F2/CXjdIhoATQfyxHDe12uut4cRqPNO7zAQvmmv+ALZQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFnEwopV2ryt3XCr4HRnhjkqm8iGCcoTkqhemdj38dk4AiEA0ppSqmyhm4WZ0jYc4SskjUnccoQrsNlpZEPW4aLyjd8="}]}},"0.2.1":{"name":"gitbook2edx","version":"0.2.1","description":"Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.","bin":{"gitbook2edx":"./bin/gitbook2edx"},"scripts":{"test":"make test"},"keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","dependencies":{"LiveScript":"^1.3.1","babel":"^4.7.16","base64-url":"^1.2.0","bluebird":"~2.3.11","browserify":"^13.0.0","chalk":"^0.5.1","cssify":"^0.6.0","date.js":"~0.2.0","debug":"~2.1.0","diff-files":"^0.1.0","docopt":"~0.4.1","gitbook":"^1.5.0","glob":"~4.3.1","highlight.js":"^8.5.0","js-yaml":"~3.2.3","liquid-node":"~2.4.0","liveify":"^2.0.0","lodash":"~2.4.1","marked":"~0.3.2","mocha":"^2.2.1","moment":"~2.8.4","pretty-xml":"^1.0.3","shelljs":"~0.3.0","uid":"0.0.2","underscore.string":"~2.4.0","verb":"^0.6.2","verb-cli":"^0.4.6","xyz":"^0.5.0"},"devDependencies":{"chai":"^2.2.0","chai-as-promised":"^4.3.0","mocha":"^2.2.1"},"gitHead":"f809f201e5bb2e37fd40715acb757bc6c7a54864","_id":"gitbook2edx@0.2.1","_shasum":"d4fe23869de75031c78b30c06e01d37a636c7f89","_from":".","_npmVersion":"2.11.2","_nodeVersion":"0.12.5","_npmUser":{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"},"maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}],"dist":{"shasum":"d4fe23869de75031c78b30c06e01d37a636c7f89","tarball":"https://registry.npmjs.org/gitbook2edx/-/gitbook2edx-0.2.1.tgz","integrity":"sha512-VUWw1dzlH4D9H1FoypTsfozkmGStpZCiAIS/Ze1vQ3hNrS/33bo7IZq3ceiDGna2trC9mQAmnftupms/0mDIOA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICYNUzhIkA/ps54424dEV4TBVPqutFzQbyufnSb3rbPHAiEA1LPwDBnoDIChI2EX9flV+WZmPDmx10Ov6YlB1UYn12w="}]}}},"readme":"gitbook2edx [![NPM version](https://badge.fury.io/js/gitbook2edx.svg)](http://badge.fury.io/js/gitbook2edx)\n================================\n\n> Convert a Gitbook into an Edx course. It generates a file  ready to be imported in Edx Studio.\n\n## Install globally with [npm](npmjs.org):\n\n```bash\nnpm i -g gitbook2edx\n```\n\nGeneral help\n------------\n\n    Usage:\n    gitbook2edx gen DIR [ -c CONFIG ]\n    gitbook2edx json DIR [ -c CONFIG ]\n    gitbook2edx info DIR [ -c CONFIG ]\n    gitbook2edx -h | --help\n\nOptions:\n    -h, --help              Just this help\n    -c, --config CONFIG     Filename of the YAML configuration of the course\n\nArguments:\n    DIR                     Root directory of the Gitbook to be converted\n\nCommands:\n    gen                     Generate the `course.tar.gz` file for the gitbook in DIR.\n\n\nDetailed help\n-------------\n\n**Warning**: This command assumes a Gitbook 1.5.0 (or lower) format for\nyour book. I dont plan to follow strictly Gitbook releses, especially\nconcerning exercise authoring.\n\nThis command generates an archive with all the XML/HTML files needed to\nbootstrap an Edx course based on a Gitbook. The following mappings are\nused\n\n-   Gitbook section -\\> Edx Chapter\n-   Gitbook subsection -\\> Edx Sequential (plus one Edx Vertical for the\n    content)\n\nAt the moment, only HTML is included in `course.xml`. In the future we\nplan to convert also Gitbook exercises.\n\nA part from `course.xml`, the archive will contain an `about` folder\nwith the required `overview.html` and `short_description.html`. Static\ndata, such as the course image and the js/css assets will be included in\nthe `static` subfolder.\n\n### Prerequisites\n\nTo generate the course archive (`course.tar.gz`), the following\ninformation is needed:\n\n-   the root directory (`DIR`) of the Gitbook to be imported\n-   the YAML configuration file (`CONFIG`) for the course. This one\n    specifies the metadata information of the course such as start and\n    end times, course description, teacher's bios. By default, this\n    command looks for a `config.yaml` file in `DIR`. You can specify\n    another value through the command line.\n-   Optional: one `js` and one `css` file to be included as static\n    assets in each vertical.\n\n### Example\n\nTo generate `course.tar.gz` for a Gitbook in `test/javascript-master`\n(assuming the configuration is `test/javascript-master/config.yaml`):\n\n    gitbook2edx gen test/javascript-master\n\n### Configuration file\n\nHere you can find the configuration file `config.yaml` that shows the\nmandatory information needed in the `config.yaml` file:\n\n``` yaml\n---\ncourse:\n    name: 'Computer Science'\n    number: '80169'\n\n    # The following two get concatenated to obtain the url_name\n    year: '2014'\n    season: 'spring'\norganization:\n    name: 'EXAMPLE-ORGNAME'\n```\n\nwhile all the available configuration options for the course are shown\nhere:\n\n``` yaml\n---\ncourse:\n    name: 'Computer Science'\n    number: '80169'\n\n    # The following two get concatenated to obtain the url_name\n    year: '2014'\n    season: 'spring'\n\n    # Important dates (use JS's native Date parsing)\n    start: 'March 1, 2015 8:00'\n    end: 'June 3, 2015'\n\n    enrollment_start: 'Feb 1, 2015'\n    enrollment_end: 'Feb 1, 2015'\n\n    # This is always relative to the 'DIR/_assets' directory\n    image: 'course-image.jpg'\n\norganization:\n    name: 'EXAMPLE-ORGNAME'\n\nassets:\n    # The following are always relative to the 'DIR/_assets' directory\n    # They are included in each vertical.\n    js: 'client.js'\n    css: 'client.css'\n\ninfo:\n    about: |\n        You can use **markdown** here\n\n    prerequisites: |\n        You can use **markdown** here\n\n    course-staff:\n\n      - name: 'John Doe'\n        image: 'http://www.dropbox.com/u/3989328983232y/image.jpg'\n        bio: 'xlkxz xz lxzlk'\n\n    faq:\n      - question: 'Silly question?'\n        answer: 'yes'\n\nshort-description:\n    150 characters of course description.  \n```\n\nHow to write exercises for the book.\n------------------------------------\n\nA programming exercise is defined directly in markdown by writing 4 simple parts between two `----` headers:\n\n-   Exercise Message/Goals (in markdown/text)\n-   Initial code to show to the user, providing a starting point\n-   Solution code, being a correct solution to the exercise\n-   Validation code that tests the correctness of the user's input\n\ne.g:\n\n    ----\n\n    This is an octave exercise\n\n    ``` octave\n    a = 2034547;\n    b = 1.567;\n    c = 6758.768;\n    d = 45084;\n    x =\n    ```\n\n    ``` octave\n    var a = 2034547;\n    var b = 1.567;\n    var c = 6758.768;\n    var d = 45084;\n\n    var x = ((a + b) / c) * d;\n    ```\n\n    ``` octave\n    assert(x == (((a + b) / c) * d));\n    ```\n\n    ----\n\n#### Quizzes\n\nFor quizzes the parts change a bit:\n\n-   Exercise Message/Goals (in markdown/text)\n-   All options allowed in the quiz (on separate lines)\n-   All options associated with the solution\n-   Feedback when the user fails to answer\n\ne.g:\n\n    ---\n\n    What is the value of variable `x`\n\n    ``` quiz\n    3\n    1\n    2\n    ```\n\n    ``` quiz\n    1\n    ```\n\n    ``` quiz\n    `x` is the result of 3%2!\n    ```\n    ---\n\nAuthor\n------\n\n-   Vittorio Zaccaria\n\nLicense\n-------\n\nCopyright (c) 2016 Vittorio Zaccaria   Released under the  license\n\n------------------------------------------------------------------------\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on January 18, 2016._\n","maintainers":[{"name":"vzaccaria","email":"vittorio.zaccaria@gmail.com"}],"time":{"modified":"2022-06-18T12:23:31.670Z","created":"2014-12-11T10:15:20.190Z","0.0.1":"2014-12-11T10:15:24.555Z","0.0.2":"2014-12-11T10:23:19.955Z","0.0.3":"2014-12-11T10:47:17.411Z","0.0.4":"2014-12-11T10:56:19.832Z","0.0.5":"2014-12-11T11:05:56.816Z","0.0.6":"2014-12-11T11:13:50.858Z","0.0.7":"2014-12-11T11:50:36.017Z","0.1.0":"2015-01-30T14:42:49.991Z","0.1.1":"2015-03-27T14:22:11.374Z","0.2.0":"2015-04-10T16:28:08.290Z","0.2.1":"2016-01-18T11:52:09.871Z"},"readmeFilename":"readme.md","keywords":[],"author":{"name":"Vittorio Zaccaria"},"license":"BSD","users":{"cycomachead":true,"lvivier":true}}