Website for Aether help and documentation
OTHER License
This README file contains information about the Aether help website (help.aetherlog.com), which is the online help file for Aether, a ham radio logging application for OS X. It is open source so that others may contribute content, fix mistakes, or request answers to questions.
The site's content is written in Markdown and can be edited using a simple text editor.
The site is deployed using mkdocs, which is a static site generator meant for building project documentation. In order to build help.aetherlog.com:
Install mkdocs by following the instructions here. In short:
pip install mkdocs
Install the Bootstrap/Bootswatch themes:
pip install mkdocs-bootswatch
Clone the repository:
git clone https://github.com/armadsen/help.aetherlog.com.git
Build the site using mkdocs:
mkdocs build
Find the output in the ./site
directory.
You can also use mkdocs' serve
command to see a live-reloading preview of the site while you make changes.
Contributions to help.aetherlog.com are most welcome. Whether you'd like to report or fix a mistake, add new content yourself, or simply ask a question, your input is valuable. If you'd just like to report a mistake or ask a question, please open an issue. If you would like to make a change yourself, fork this repo, make the change (see further instructions below for adding new pages), then submit a pull request. See CONTRIBUTING for more information about contributing to the site.
help.aetherlog.com is a standard mkdocs site, so the process for adding content is straightforward. For detailed information, see mkdocs own documentation.
docs
folder (or a subfolder).mkdocs.yml
file. Make sure to add it to the appropriate category under pages:
, and use a good title. The existing content in mkdocs.yml is a good example to follow.If you have questions about this site, or Aether itself, please open an issue.