Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 4.66 KB

README.md

File metadata and controls

111 lines (75 loc) · 4.66 KB
Raw

haxe.org

Build Status Code Climate Issue Count

This is the code base for the https://haxe.org website.

Contributing Content

On the website there is a "Contribute" link on the footer of each page. Clicking this link will take you to the relevant file in this repository, or the relevant file in the HaxeManual repository.

You can then edit using Github's online file editor and submit a pull request. You can also fork the repo and edit on your local machine with your preferred text editor, which may be easier for large integrations.

Adding a blog post

Add a file named YEAR-MONTH-DAY-name.md in posts/.

The first part of the file contains the post metadata:

title: The title of your post
author: Author id
description: The description of your post
background: Optional image filename used as background for the post header
published: true/false, if true it'll apear in the blog post list/rss feed
tags: Comma separated of tags id
disqusID: Unique id number used for comments, take the number of the last post and increment it by one
---

The author id should be listed in people.json:

{
  "username": "the user id used in the post",
  "name": "Your Name",
  "bio": "One line bio about you"
}

The background image should be stored in www/img/blog/backgrounds/.

The tags should be listed in posts/tags.json:

{
  "tag": "the tag id",
  "name": "the tag display name",
  "description": "the tag description, shown on the tag post list"
}

The post needs to have the --- and the blank line between the metadata and the content.

The content of a post is in markdown, but you can include some html. If you do it needs to be valid xml, so all tags needs to be closed: <br /> is okay but <br> is not, and you can't have value-less attributes: <tag fullscreen="" /> is okay but <tag fullscren /> is not.

To include an image in markdown: ![Title](name.png). The image should be stored in www/img/blog/YEAR-MONTH-DAY-name/.

Issues, bugs and suggestions

If you find a bug, have an issue, suggestion, or want to contribute in some other way, please use the Github Issue Tracker.

Any bugs we will attempt to address promptly. New content or subjective issues (colours, fonts, marketing material etc) will be considered on a case by case basis.

If you are a designer and want to help freshen up the look of the site, please open an issue or contact [email protected]. We'd love your input!

Contributing CSS

Currently the css for the site is in www/css/style.css.

We currently use the bootstrap 2.3.2 CSS library and the Font Awesome 4.1.0 icon library.

Structure

  • The pages content are in pages/, in either html or markdown.
  • The blog posts are in posts/ in markdown, and their images are in www/img/blog/$name/.
  • The release messages for the haxe versions are in releaseNotes/, in markdown.
  • The code is in src/. The generations calls src/Main.hx and the javascript src/Client.hx.
  • The views are in views/ and uses the haxe template syntax with foreach disabled.
  • The static assets are in www/.

Running a local copy for development

The haxe.org website was designed to be easy to generate, to run a local copy follow these steps:

Requirements

  • Haxe
  • Haxelib
  • Neko
  • cUrl
  • NodeJS
  • npm

Setting up

  • Install the dependencies haxelib install all and npm install in the root directory.
  • Update submodule dependencies git submodule init && git submodule update.
  • Clone the manual into the manual directory with git clone https://github.com/HaxeFoundation/HaxeManual.git manual.
  • Generate the website by running haxe generate.hxml.

The website is now available in the out/ folder, you can launch it with nekotools server -d out and access it at http://localhost:2000/.

Deploying updates

  • Any push or merge to the staging branch will trigger Github Actions to build and deploy to "staging.haxe.org".
  • Any push or merge to the master branch will trigger Github Actions to build and deploy to "haxe.org".