diff --git a/assets/docs/_static/README.md b/assets/docs/_static/README.md new file mode 100644 index 0000000..0305e36 --- /dev/null +++ b/assets/docs/_static/README.md @@ -0,0 +1 @@ +static files for your documentation should be placed here... \ No newline at end of file diff --git a/assets/docs/index.rst b/assets/docs/index.rst index 9ba71e1..f537dcd 100644 --- a/assets/docs/index.rst +++ b/assets/docs/index.rst @@ -1,15 +1,11 @@ Your Project ============ -Some words about your project. Maybe even include your README file here. - -Contents: +Some words about your project which might be a `Node.js`_ library. Maybe even include your README file here. .. toctree:: :maxdepth: 2 - - Indices and tables ================== @@ -17,3 +13,4 @@ Indices and tables * :ref:`modindex` * :ref:`search` +.. include:: links.txt diff --git a/assets/docs/links.txt b/assets/docs/links.txt new file mode 100644 index 0000000..a1feb7b --- /dev/null +++ b/assets/docs/links.txt @@ -0,0 +1 @@ +.. _Node.js: http://nodejs.org \ No newline at end of file diff --git a/assets/themes/mocha/layout.html b/assets/themes/mocha/layout.html index d10a66d..6bc2cd1 100644 --- a/assets/themes/mocha/layout.html +++ b/assets/themes/mocha/layout.html @@ -1,7 +1,7 @@ {% extends "basic/layout.html" %} {% block footer %} {% if github_url %} - Fork me on GitHub + Fork me on GitHub {% endif %} {{ super() }} diff --git a/docs/work-smarter.rst b/docs/work-smarter.rst index 38a9f21..25a44df 100644 --- a/docs/work-smarter.rst +++ b/docs/work-smarter.rst @@ -13,7 +13,7 @@ Certain information in your Sphinx generated documentation comes from placeholde Simply run the following command within your Node.js project directory:: - docstar sync + docstar config sync This will update particular pieces of information in configuration file. At this stage the following information is taken from your ``package.json`` file and placed in your ``conf.py`` file: diff --git a/lib/commands/scaffold.js b/lib/commands/scaffold.js index 3fad140..ba0b1e7 100644 --- a/lib/commands/scaffold.js +++ b/lib/commands/scaffold.js @@ -8,14 +8,15 @@ exports.args = { // export runner exports.run = function(opts, callback) { - var scaffolder = this; + var scaffolder = this, + done = callback; // scaffolder.chain('config create', opts, callback); require('../docstar').init(function(err, docstar) { if (err) { scaffolder.out('!{red}{0}', err); } else { - scaffolder.copy(path.join('assets', 'docs'), docstar.path, callback); + scaffolder.copy(path.join('assets', 'docs'), docstar.path, done); } }); }; \ No newline at end of file