Birdhouse Website

This is the source of the Birdhouse Website.

The Birdhouse Website is the main site for the Birdhouse project where you can find links to documentation and demos.

Contributing

Contributions are welcome. Feel free to open a pull request with changes.

Running it Locally

It can be helpful to preview changes on your computer before opening a pull request. The Birdhouse Website uses MkDocs to build GitHub-Pages from Markdown.

Clone this repository locally, and cd into it:

git clone https://github.com/bird-house/bird-house.github.io
cd bird-house.github.io

Install mkdocs, for example with conda:

conda env create
conda activate birdhouse2

Now you can ask mkdocs to build the website:

mkdocs build
mkdocs serve

Point your browser at http://127.0.0.1:8000/.

Edit the various parts, mkdocs should automatically rebuild and refresh the pages when changes occur.

To stop serving the website, press Ctrl-C in your terminal.

Deployment

Pull requests merged to the main branch are automatically deployed to the production website.

Where to Edit?

You can edit the main page of the website by changing index.md. It is written in Markdown.

The site has other pages written in Markdown like about.md.

To customise the layout read the documentation of Material for MkDocs.