Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lewisakura committed Jun 9, 2018
1 parent e6ffd37 commit beaf69b
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/help.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Help
====

Brings you to the ReadTheDocs page, or the page for the command specified.

+-----------+------------------------------------------------------------+
| Parameter | Description |
+===========+============================================================+
| command | The command to automatically go to on the doucmentation. |
+------------------------------------------------------------------------+

Usage
-----
.. code::
# help [command (optional)]
15 changes: 15 additions & 0 deletions docs/highlight-updates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Highlight-Updates
=================

Highlights whenever an element updates with a red outline that disappears after a second, à la React's "Highlight Updates".

+-----------+------------------------------------------------------------+
| Parameter | Description |
+===========+============================================================+
| toggled | Toggles whether Commander should highlight updates or not. |
+------------------------------------------------------------------------+

Usage
-----
.. code::
# highlight-updates [toggled]
19 changes: 18 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
.. include:: ../README.rst
Commander
=========

Welcome to the documentation for Commander!

.. toctree::
:maxdepth: 2
:caption: Commander

using-commander

.. toctree::
:maxdepth: 2
:caption: Commands

help
highlight-updates
version
4 changes: 4 additions & 0 deletions docs/using-commander.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Using Commander
===============

To use Commander, go to the address bar (known as the omnibox), type `#` and press space. This will bring you into the Commander prompt. As you type, Commander will look through its commands to see if your query matches any of them.
9 changes: 9 additions & 0 deletions docs/version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Version
=======

Shows you the version of Commander you're running in a popup.

Usage
-----
.. code::
# version

0 comments on commit beaf69b

Please sign in to comment.