# floyd-docs

**Repository Path**: githubtx/floyd-docs

## Basic Information

- **Project Name**: floyd-docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-24
- **Last Updated**: 2021-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[Website](https://www.floydhub.com) • [Docs](https://docs.floydhub.com) • [Forum](https://forum.floydhub.com) • [Twitter](https://twitter.com/floydhub_) • [We're Hiring](https://angel.co/floydhub) • [Write for FloydHub ✏️](https://blog.floydhub.com/write-for-floydhub)

[![FloydHub Logo](https://github.com/floydhub/static/blob/master/Group.png)](https://www.floydhub.com)

# FloydHub Documentation

[![Netlify Status](https://api.netlify.com/api/v1/badges/6da180d6-ff32-42ea-8024-56258927e9cd/deploy-status)](https://app.netlify.com/sites/floydhub-docs/deploys)

This code generates FloydHub's documentation: [http://docs.floydhub.com/](http://docs.floydhub.com/).

## Contributing
Please feel free to make pull requests or file issues if you think there's anything missing or if there's something we should explain more clearly. We love pull requests!

### Running docs locally
* Install requirements.txt with `pip install -r requirements.txt`
* Use `mkdocs serve` to run a local server and build/preview documentation. You can view the docs at [ http://127.0.0.1:8000]( http://127.0.0.1:8000)
* To build the static site, use `mkdocs build`.

### Steps to deploy (only admins)
Any pushes or merges to master will deploy to Netlify automatically.