Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs @ 750a9ea
site
theme
.gitmodules
LICENSE
README.md
mkdocs.yml

README.md

pisound-docs

If your are looking for Pisound documentation, head straight to the Wiki page!

Contribution guide

Everyone can contribute through GitHub Wiki UI or cloning repo git clone http://github.com/BlokasLabs/pisound-docs.wiki.git.

Uploading images

git clone http://github.com/BlokasLabs/pisound-docs.wiki.git cd ./pisound-docs.wiki/images

Displaying images

![name](https://raw.githubusercontent.com/wiki/BlokasLabs/pisound-docs/images/{name}.png)

Linking to a section

To create an anchor to a heading in github flavored markdown. Add - characters between each word in the heading and wrap the value in parens (#some-markdown-heading) so your link should look like so:

[Linking to a section](#section-name) [Linking to a section in another page](page-name#section-name)

Docs page generation

pip install mkdocs
  1. Rename .\pisound-docs\docs\Home.md to .\pisound-docs\docs\index.md
  2. When in .\pisound-docs\ run mkdocs build
  3. For preview run mkdocs serve
  4. Rename .\pisound-docs\docs\index.md to .\pisound-docs\docs\Home.md
  5. Upload .\pisound-docs\site\ folder to the server