Adjustments to docs formatting

Also add a mkdocs.yml
Mapita · Mar 27, 2018 · 8fbfc71 · 8fbfc71
1 parent 74c40fb
commit 8fbfc71
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -392,7 +392,7 @@ Get a summary string describing the status of every test that was attempted.
 
 Example of a string returned by a call to `getSummary` after running tests:
 
-``` text
+```
 ✓ Canary (0.003s)
   ✓ leftPad (0.001s)
     ✓ returns the input when it's as long as or longer than the input length (0.000s)

diff --git a/docs/index.md b/docs/index.md
@@ -47,7 +47,7 @@ require("canary-test").doReport();
 
 And this would output to the console...
 
-``` text
+```
 sophie:shorter pineapple$ node testLeftPad.js
 Running tests via Canary...
 Completed test "leftPad => returns the input when it's as long as or longer than the input length". (0.000s)

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Canary
+pages:
+    - Home: index.md
+    - API Documentation: api.md
+theme: readthedocs