Merge pull request #61 from DudeBro249/documentation

Change documentation to reflect new cli syntax

Author: srinivasayush

LICENSE

@@ -1,4 +1,4 @@
-Apache License
+                                 Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 

website/docs/general-commands/init.md renamed to website/docs/commands/init.md

@@ -1,20 +1,20 @@
 ## Usage
 ```
-docrunner init [OPTIONS]
+docrunner run [arguments]
 ```
 
 ```
 $ docrunner init --help
-Usage: docrunner init [OPTIONS]
+Create a `docrunner.toml` configuration file in the root directory
 
-  Creates a `docrunner.toml` configuration file in the root directory
+Usage: docrunner init [arguments]
+-h, --help    Print this usage information.
 
-Options:
-  --help  Show this message and exit.
+Run "docrunner help" to see global options.
 ```
 
 ## What it does
-Creates a `docrunner.toml` configuration file with some default options:
+Creates a `docrunner.toml` configuration file with some default options in the root directory:
 
 ```toml
 [docrunner]

website/docs/commands/run.md

@@ -0,0 +1,35 @@
+## Usage
+```cmd
+docrunner run [arguments]
+```
+
+```
+$ docrunner run --help
+Runs all code belonging to a specific language within a markdown '.md' file
+
+Usage: docrunner run [arguments]
+-h, --help               Print this usage information.
+-l, --language           The language that will be located and run within your '.md' files
+-m, --markdown-path      The path to the markdown file you would like to run code from
+-d, --directory-path     The path to the directory where your code should be stored and run
+                         You can install dependencies, for example, in this directory
+-s, --startup-command    The command you would like to run in order to run
+                         your code. Put the command in between quotes "node index.js"
+-f, --[no-]multi-file    Whether each snippet (denoted by ```) should be placed and run in a
+                         different file
+
+Run "docrunner help" to see global options.
+```
+
+## What it Does
+Runs your documentation using both configuration found in your `docrunner.toml` 
+file and cli arguments shown here
+
+You can learn more about docrunner configuration [here](/docs/configuration)
+
+## Supported Languages
+
+- Python - `docrunner run --language python`
+- Javascript - `docrunner run --language javascript`
+- Typescript - `docrunner run --language typescript`
+- Dart - `docrunner run --language dart`

website/docs/general-commands/run.md

@@ -1,30 +1,25 @@
 # Getting started
 
-## Installation
-_Prerequisite: [Install Python 3.6.1+](https://www.python.org/) on your local environment._
+<!-- ## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install docrunner.
 
 ```cmd
 pip install docrunner
-```
+``` -->
 
 ## QuickStart
 
-```powershell
+```shell
 docrunner --help
 ```
 
-## Language Specific Help
-For help on a specific language, run:
-```powershell
-docrunner <language> --help
-```
-
 ## Python Example
 
 ```powershell
-docrunner python --markdown-path README.md --multi-file
+docrunner run --language python --markdown-path README.md --multi-file
 ```
 
-- This command executes all python within `README.md` and does so by putting each snippet of python into a separate file, and running each file. If you don't want each snippet in a separate python file, just remove the --multi-file option.
+- This command executes all python within `README.md` and does so by putting each snippet of python into a 
+separate file, and running each file. If you don't want each snippet in a separate python file, just 
+remove the --multi-file option.

website/docs/getting-started.md

@@ -19,23 +19,8 @@ module.exports = {
         'getting-started',
         {
             type: 'category',
-            label: 'General Commands',
-            items: [
-                {
-                    type: 'autogenerated',
-                    dirName: 'general-commands',
-                },
-            ],
-        },
-        {
-            type: 'category',
-            label: 'Language Specific Commands',
-            items: [
-                {
-                    type: 'autogenerated',
-                    dirName: 'language',
-                },
-            ],
+            label: 'Commands',
+            items: ['commands/run', 'commands/init'],
         },
         'comments',
         'configuration',