Mono Project Website
This repository contains the files used for generating the Mono website at http://www.mono-project.com.
The site uses Jekyll (http://jekyllrb.com), a static site generator. GitHub Pages, where the site is hosted, natively supports Jekyll so every time someone pushes to this repository, the website will be built and updated. For hosting it yourself, see Setting up a local copy of the website.
Contributing to the website
Note: Major issues or feature requests should be filed on the issue tracker first, so we can discuss the implications.
If you want to edit a page, the easiest way is to click the link under the page title on the website.
This will open the source file on GitHub where you can click the pencil button to start editing:
GitHub's editor shows you both the Markdown source as well as a preview of the rendered page:
After you've finished your changes, enter a proper summary and description and click the "Propose file change" button to open a pull request:
Setting up a local copy of the website
For larger changes, using the web-based editor on GitHub is not really convenient. A better way is to setup a local copy of the website where you can experiment.
Dependencies
- Ruby - Jekyll is written in Ruby
- Bundler - a package manager for Ruby. Install it by running
gem install bundler
After you've forked and cloned the repository, run the following commands:
bundle install
- downloads the required librariesjekyll serve
- builds the website and runs a local webserver on port 4000
Note: you can add the --watch
option when running jekyll serve
to let Jekyll watch for file changes, which means the site will be rebuilt when a file is modified.
The site should now be running locally:
Repository structure
_includes
- special folder contains snippets that can be included via{% include file.html %}
in other pages_layouts
- special folder contains the layouts that are shared between pages. Layouts can be inherited, the root layout isbase.html
._posts
- special folder, contains the source pages for the blog section, see Writing a blog post_site
- the output of the generated site is stored here by default, this folder only exists after Jekyll built the sitearchived
- content that is no longer relevant but kept to keep external links workingcommunity
- contains the source pages for the/community
website sectioncss
- contains the main stylesheetdocs
- contains the source pages for the/docs
website sectiondownload
- contains the source pages for the/download
website sectionimages
- stores the images used in pagesnews
- lists the blog pages from the_posts
directory
Writing a blog post
Blogging is very easy with Jekyll. Simply add a new Markdown file to the _posts
folder following the file name convention: YEAR-MONTH-DAY-title.md
Make sure to not include special characters in the file name. The blog entry's publishing date is automatically extracted from the file name.