Skip to content
Documentation repository for all Textile projects πŸ“š
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs adds link to boilerplate (#87) May 25, 2019
material Fix build, add a bit more content (#11) Apr 4, 2019
snippets
.gitignore
CODE_OF_CONDUCT.md readme: fix broken links Mar 28, 2019
CONTRIBUTING.md
LICENSE Create LICENSE Mar 5, 2019
Makefile adding code snippets to unified yml (#44) May 3, 2019
README.md Added information about installing make on Windows. (#57) May 8, 2019
mkdocs.yml Couple fixes; Mostly just referring to JS as JavaScript (#83) May 24, 2019
yarn.lock

README.md

Textile Docs (docs)

Made by Textile Chat on Slack

Documentation repository for all Textile projects πŸ“š

Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.

Table of Contents

Getting Started

Requirements

  • python >= 3.6.0
  • pip >= 19.0
  • wget >= 1.0

Commands

Install dependencies:

$ make setup

Build docs

$ make build

Serve locally

$ make serve

Pull latest downstream docs

$ make sync

Deploy to docs.textile.io

$ make deploy

Note for Windows Users

Windows doesn't come with make. In order to access the tool and contribute to these docs, we recommend installing a windows port of the tool. If you're using Git Bash, we recommend following Evan Will's guide to adding more tools to Git Bash.

Maintainer

Carson Farmer

Contributing

Contribute to the Textile Docs with any additions or questions you have about Textile and its various projects. A good example would be asking, "What is a thread?". If you don't know a term, odds are someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make Textile even better.

Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.

Contributors

License

MIT

You can’t perform that action at this time.