Skip to content

atuttle/TaffyDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Taffy Documentation

This repo is the source of the documentation for Taffy.

To submit changes for the docs site, fork this repo and send a pull request. If you want to edit something in the wiki then file a bug or contact me directly. One day I hope to have everything migrated out of the wiki.

The files you need to edit are markdown files in the src folder, named after their affected version. If your change is not applicable until the next release (e.g. only available in the master branch of Taffy) then you'll need to create a new file (by copying the latest version's file and modifying it as appropriate). Please ask what to name the new file, as there are always a few different options for the next version number.

Thanks for your contributions!

Compiling

The documentation is compiled by docsify.

  1. Install the tool globally with npm i -g docsify-cli
  2. In the TaffyDocs folder you can run it locally by running docsify serve src.