Giter Club home page Giter Club logo

builtwithdart.com's Introduction

Contributing via Github

This website is built using a similar (but smaller) set of tools to the dartlang website, described on Seth Ladd's blog. At the minimum, you will need Jekyll, a ruby based static site generator.

To run the site locally:

  1. Check out the code from github
  2. Change into the /src/site folder
  3. Run jekyll from the command line
  4. Browse to http://localhost:8091 and you should see the site.

The static output generated by jekyll is deployed to google appengine. You should normally not need to worry about this if you just want to see what your pages look like.

Creating a page for your project:

  1. Create a folder in the relevant /projects subfolder, eg: /projects/apps/awesome/
  2. Create an index.md file by copying the /project/template.md file, eg: `/projects/apps/awesome/index.md'
  3. Edit the _includes/header.html file to add a link to your project on the menu, eg: <li><a href="/projects/apps/awesome/">RGB Cube</a></li>
  4. Add some screenshots or other images into your project's folder, eg: /projects/apps/awesome/myapp.png
  5. Fill in the various fields in your index.md and add some text
  6. Git Add, Commit and Push, then make a pull request on github. (Contact me if you need help - I'm happy to do this if you send over some text and images!)

The template.md file looks like the following. The part between the --- forms the top part of the page, and injects some meta-data into the html.

---
layout: project
title: 'Your Project Title Here'
download_url: http://<Download URL for your project>
added: <19/Nov/2012 - NOW>
updated: <If you're editing, update this>
description: 'My Awesome Project creates Foos in Dart'
author_name: Your Name
author: http://<a link to your G+ url>
mainimage: myproject.png

author_image: https://profiles.google.com/s2/photos/profile/1234567890 -> The long number from your G+ url - OPTIONAL
source: http://<github/myAwesomeProject (or other source url) - OPTIONAL
homepage: http://my.awesome.project - OPTIONAL
forum: http://groups.google (or other discussion forum) - OPTIONAL
blog: http://<blog.myAwesomeProject - OPTIONAL
---

### Author's Notes

TODO: Enter some text about your project

### Demos

[Launch Demo](http://my.demo.url)

![My Demo Screenshot](screenshot.png)

builtwithdart.com's People

Contributors

chrisbu avatar kevmoo avatar dzenanr avatar claudiodangelis avatar atebitftw avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.