https://github.com/elk-audio/elk-docs
User documentation for Elk Audio OS
https://github.com/elk-audio/elk-docs
audio elk elk-audio linux low-latency vst
Last synced: 1 day ago
JSON representation
User documentation for Elk Audio OS
- Host: GitHub
- URL: https://github.com/elk-audio/elk-docs
- Owner: elk-audio
- Created: 2019-11-05T09:04:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-03-30T09:32:35.000Z (7 days ago)
- Last Synced: 2026-03-30T11:31:26.158Z (7 days ago)
- Topics: audio, elk, elk-audio, linux, low-latency, vst
- Language: Python
- Homepage: https://elk-audio.github.io/elk-docs/html/index.html
- Size: 56.6 MB
- Stars: 44
- Watchers: 6
- Forks: 10
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Elk Development Kit Documentation
To read the documentation, follow this link: https://elk-audio.github.io/elk-docs/
This repository contains the source files, and generated HTML output, for the Elk Development Kit Documentation.
If you have cloned/downloaded this repository you can browse the documentation by opening the `./docs/index.html` file in your browser.
Most sections are written in MarkDown, and have to use the [CommonMark flavor](https://commonmark.org/), the accepted standard by [Sphinx](http://www.sphinx-doc.org) and [ReadtheDocs](https://readthedocs.com/). Some exceptions, such as is the index, use ReStructuredText - the main format for Sphinx.
## Building HTML From Source Files
If you have made any changes to an .MD documentation file, you also need to take the below steps to make the changes available through the web link.
Install [Sphinx](http://www.sphinx-doc.org/en/stable/):
pip install -r requirements.txt
Alternatively, via apt (discouraged)
apt-get install python3-sphinx
Build with:
make html
Alternatively, if you've pip-installed Sphinx:w
python3 -m sphinx -M html ./ ./docs/
The output will be generated in `docs`, the folder expected by GitHub Pages for the HTML files it serves.
Do commit and push both your changed .MD, and generated HTML files, for your changes to be reflected on the online HTML version of the documentation.
In the `docs` folder, there are two files added manually, needed for GitHub Pages: `.nojekyll`, and `index.html`. If you every type `make clean`, these two will be deleted - ensure you then reinstate them before committing.