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.
Contributions are welcome. Feel free to open a pull request with changes.
It can be helpful to preview changes on your computer before opening a pull request. The Birdhouse Website uses the Jekyll static site generator.
Clone this repository locally, and cd into it:
$ git clone https://github.com/bird-house/bird-house.github.io
$ cd bird-house.github.io
Make sure you have ruby installed on your computer. See https://www.ruby-lang.org/en/downloads/.
Install bundler, and use it to install the dependencies to build the website:
gem install bundler
bundle install
Now you can ask Jekyll to build the website:
bundle exec jekyll build
bundle exec jekyll serve
Point your browser at http://localhost:4000.
Edit the various parts, Jekyll should automatically rebuild and refresh the pages when changes occur.
To stop serving the website, press Ctrl-C in your terminal.
Pull requests merged to the master branch are automatically deployed to the production website.
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 the minima theme.
- Jekyll minima theme (view)
- Jupyter Website based on minima theme (view)
- Markdown