md-website

MonoDevelop WebSite

  • 所有者: mono/md-website
  • 平台:
  • 許可證:
  • 分類:
  • 主題:
  • 喜歡:
    0
      比較:

Github星跟蹤圖

MonoDevelop Website Build Status

This repository contains the files used for generating the MonoDevelop website.

Architecture

The site is made with Jekyll, an open source 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 Edit page on GitHub 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:
Arrow to pencil

GitHub's editor shows you both the Markdown source as well as a preview of the rendered page:
Code editor

After you've finished your changes, enter a proper summary and description and click the "Propose file change" button to open a pull request:
Propose file change

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:

  1. bundle install - downloads the required libraries
  2. bundle exec jekyll 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.

Note 2: on case-insensitive file systems like on Windows and macOS you'll run into redirect loops for some URLs. The workaround is to disable redirects locally by removing the gems: jekyll-redirect-from entry from _config.yml.

The site should now be running locally:

MD website

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 is base.html.
  • _site - the output of the generated site is stored here by default, this folder only exists after Jekyll built the site
  • archived - content that is no longer relevant but kept to keep external links working
  • css - contains the main stylesheet
  • developers - contains the source pages for the /developers website section
  • documentation - contains the source pages for the /documentation website section
  • download - contains the source pages for the /download website section
  • help - contains the source pages for the /help website section
  • images - stores the images used in pages
  • screenshots - contains the source pages for the /screenshots website section

主要指標

概覽
名稱與所有者mono/md-website
主編程語言HTML
編程語言HTML (語言數: 4)
平台
許可證
所有者活动
創建於2014-11-02 18:08:19
推送於2025-07-02 15:09:04
最后一次提交
發布數0
用户参与
星數85
關注者數44
派生數87
提交數415
已啟用問題?
問題數33
打開的問題數13
拉請求數134
打開的拉請求數0
關閉的拉請求數13
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?