Nightscout Documentation

This is the repo that contains the source files for the Nightscout Docs site.

Contributing

To suggest changes, fork this repository, edit the files, and submit your changes as a pull request.

The developer discussion of Nightscout happens on our Discord channel at https://discord.gg/zg7CvCQ

Previewing Changes

To preview your work as you edit you must set up two python packages that are used to create this site using MkDocs. They are mkdocs, and mkdocs-bootswatch.

Review Properly Installing Python for help getting Python installed. MkDocs works with Python 2.7, 3.3+, and pypy.

• Install python modules

$ cd <nightscout docs location>
$ pip install -r requirements.txt

• Install Material theme

$ pip install mkdocs-material

• Run mkdocs server locally

$ cd <nightscout docs location>
$ mkdocs serve

• Preview docs in browser. Most changes will update automatically as you edit. Configuration and navigation changes will require restarting the MkDocs server.
• Do you see error "'mkdocs' is not recognized as an internal or external command, operable program or batch file." on Windows? This is a known problem with Python on Windows. Basically you need to add the "Scripts" directory to your PATH environment variable. If you are uncomfortable editing environment variables, you can use python -m mkdocs as the command

$ cd <nightscout docs location>
$ python -m mkdocs serve

• Optionally, you can share the preview with others by uploading them to your repository's gh-pages branch

$ mkdocs gh-deploy

Conventions

• Use images for clarity whenever appropriate

Admonitions

Admonitions are a markdown extension that enable formatted blocks for visually calling out information. The types are: note, info, warning, and danger. Here are some examples of how to write the markdown:

!!! note
    This admonition uses the default title: 'Note'.

!!! info "My Custom Title"
    This admonition is blue and has a custom title.

!!! warning ""
    This admonition is yellow and has no title.