github.com/mweagle/Sparta@v1.15.0/docs_source/content/meta/_index.md (about)

     1  ---
     2  date: 2018-02-24 06:29:36
     3  title: Meta
     4  weight: 1000
     5  ---
     6  
     7  Documentation contributions are most appreciated. The documentation is built using:
     8  
     9  * [Hugo](http://gohugo.io)
    10  * [Mage](https://magefile.org)
    11  
    12  All documentation is contained in the _master_ branch of the [Sparta repo](https://github.com/mweagle/Sparta).
    13  
    14  ```shell
    15  $ mage -l | grep docs
    16    docsBuild                       builds the public documentation site in the /docs folder
    17    docsCommit                      commits the current documentation with an autogenerated comment
    18    docsEdit                        starts a Hugo server and hot reloads the documentation at http://localhost:1313
    19    docsInstallRequirements         installs the required Hugo version
    20  ```
    21  
    22  ## Editing
    23  
    24    1. `go get -u -v github.com/magefile/mage`
    25    1. `mage -v docsEdit`
    26  
    27  The last step will launch a hot reloading documentation server and open a browser viewing http://localhost:1313.
    28  
    29  To make changes to the documentation:
    30  
    31  * Start the server: `mage -v docsBuild`
    32  * Edit the markdown in **/docs_source/content**
    33  * Check the changes in the browser (http://localhost:1313)
    34  * Commit your changes
    35  * Open a PR
    36  
    37  Thanks!
    38  
    39  The documentation site uses the [Hugo Learn Theme](https://themes.gohugo.io/theme/hugo-theme-learn/en). Please visit that site for additional documentation regarding shortcodes and included libraries.