Guides and Documentation developed by and for Tilde Black
Go to file
James Tomasino 7d9f686d00 adding virtualenv and easy-installer 2019-07-30 22:54:52 +00:00
docs add descriptions of black net news private groups 2019-04-26 20:38:52 -04:00
.gitignore initial docs commit 2019-04-25 00:55:20 +00:00
README.md added Readme 2019-04-24 21:01:19 -04:00
activate adding virtualenv and easy-installer 2019-07-30 22:54:52 +00:00
mkdocs.yml added net news 2019-04-26 20:22:32 -04:00
requirements.txt adding virtualenv and easy-installer 2019-07-30 22:54:52 +00:00

README.md

Tilde Black Documentation

This repository holds the outward facing guides built by users of https://tilde.black.

Local Development

Running the docs

  1. Install mkdocs according to your platform requirements. Many package managers have it included, and there is also a pip version available.

  2. Fork this repository & clone it to your system.

  3. Change to your repository directory and run:

    $ mkdocs serve

This will launch a local running version of the documentation on https://localhost:8000. As you make changes to the documentation your changes will appear in your local server.

Submitting changes

If you would like to contribute to these guides you do not need an account on tilde.black, but you may benefit from discussion in the private forums on that platform. To contribute, clone this repository, make any desired changes, and submit a pull-request.