https://github.com/thingpulse/docs

https://github.com/thingpulse/docs

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/thingpulse/docs
• Owner: ThingPulse
• License: mit
• Created: 2018-01-19T22:50:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-02-14T16:05:45.000Z (11 months ago)
• Last Synced: 2025-02-14T16:38:41.633Z (11 months ago)
• Homepage: https://docs.thingpulse.com/
• Size: 31.1 MB
• Stars: 5
• Watchers: 5
• Forks: 18
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Support: docs/support.md

Awesome Lists containing this project

README

          
# ThingPulse documentation

[![Build Status](https://travis-ci.org/ThingPulse/docs.svg?branch=master)](https://travis-ci.org/ThingPulse/docs)

[https://docs.thingpulse.com/](https://docs.thingpulse.com/)

## How to build this yourself

A Python 3 installation is required to build this documentation site. Prepare the environment with:

```

$ pip3 install -r requirements.txt

```

If `pip` points to a Python/pip 3 version you can of course also use that executable.

Then run

```

$ mkdocs serve

```

and open [http://127.0.0.1:8000]() in the browser of your choice.

**Note**

MkDocs supports hot-reloading changes. However, it does not reload master pages if one of the included pages changes. If you change any document in the `includes` folder you need to restart MkDocs to see those applied.