Merge pull request #69 from DudeBro249/documentation

Added documentation for dotenv and self update features

Author: srinivasayush

website/docs/configuration.md

@@ -56,3 +56,7 @@ between quotes like "node main.js". string, **Optional**
 ### recursive
 - Whether you want docrunner to search through specified directories recursively
 (look through sub-directories). boolean, **Optional**
+
+### dotenv
+- The path to your dotenv file(if one exists), which stores your environment variables
+and secrets. string, **Optional**

website/docs/environment.md

@@ -0,0 +1,30 @@
+# Environment Variables
+
+Environment variables allow you to store values that you do not want
+exposed to others. Docrunner allows you to load these in through the
+`docrunner.toml` configuration file
+
+You can learn more about docrunner configuration [here](/docs/configuration)
+
+```env title=".env"
+SECRET_TOKEN=secretvalue
+```
+
+```bash {3} title="docrunner.toml"
+[docrunner]
+markdown_paths = ['README.md']
+dotenv = '.env'
+```
+- In this `docrunner.toml` file we tell docrunner that we want to load the
+values in `.env` into our environment, using the <code>[dotenv](/docs/configuration#dotenv)</code>
+option
+
+We can now access the environment variables in `.env` in our code snippets:
+
+    ```python
+    import os
+
+    # Retrieve the SECRET_VALUE from our environment
+
+    SECRET_VALUE = os.getenv('SECRET_VALUE')
+    ```

website/docs/getting-started.md

@@ -26,3 +26,12 @@ 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.
+
+## Updating
+
+Updating docrunner is as simple as calling:
+```powershell
+docrunner self update
+```
+
+This will provide you with simple instructions on how to update docrunner

website/sidebars.js

@@ -9,7 +9,7 @@
  Create as many sidebars as you want.
  */
 
-module.exports = {
+const sidebars = {
     // By default, Docusaurus generates a sidebar from the docs folder structure
     // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
 
@@ -22,7 +22,10 @@ module.exports = {
             label: 'Commands',
             items: ['commands/run', 'commands/init'],
         },
+        'environment',
         'comments',
         'configuration',
     ],
 }
+
+module.exports = sidebars