Skip to content

Support the project

First of all: many thanks to spend your time on contributing to this application!

Songpress is hosted at Github and you can help in several ways:

  • reporting bugs or suggest improvements, via our issue tracker on Github
  • creating new translations
  • providing artwork (icons, buttons etc.)
  • contributing to the code, by forking our repository and submitting a pull request
  • contributing to the documentation

Contributing to the documentation

Songpress documentation site is written in Markdown and built by the following tools:

  • mkdocs static site generator
  • mkdocs-material for theme and functionalities not included in mkdocs
  • mkdocs-static-i18n to localize the site in several languages (English and Italian are available by now)

Setting up your environment

Markdown is just simple text so you can write the documentation via a text editor. But probably you may want to build and run Songpress documentation site locally, to see your contribution before submitting a pull request.

Firstly, be sure to have python installed on your computer. Open a shell and run: python --version. If Python is installed, you receive a simple output like this: Python 3.12.3.

Then create a virtual environment for Songpress and activate it(suppose your virtual environments directory is .venv):

python -m venv .venv/songpress

source .venv/songpress/bin/activate

and install all the tools via pip:

pip install mkdocs mkdocs-material mkdocs-static-i18n

Well done! Now, you are ready to run the documentation site!

Fork the repository, clone it locally and, from the root of the project, run mkdocs serve. Now, pointing your browser to http://localhost:8000, you can see the documentation site.

The serve Mkdocs command automatically update the site whenever you modify one of the documents or the configuration file mkdocs.yml.