STAR Website

External libraries

Python Markdown

1. Download Waylan Limberg's Python Markdown implementation from https://pypi.python.org/pypi/Markdown
2. Put the “markdown” folder from the .zip or .tar.gz in star-site/app

GitHub-Flavored Markdown

1. Download https://gist.github.com/smutch/1454175
2. Put the “gfm.py” file in star-site/app.

Code style

Git

• Follow standard Git commit guidelines.
  • Commits should fit in the sentence, “If applied, this commit will ___.”

Python

• Indent with tabs, NOT spaces.
• Variable names should have words sparated_by_underscores.
• Constant names should be ALL_CAPS_SEPARATED_BY_UNDERSCORES.
• Strings should use single quotes.
• Surround operators with spaces.
• The code block within a control structure (if, for, try, etc.) should be indented one additional level and not on the same line as the control structure.

HTML

• Indent with tabs, NOT spaces.
• Use valid XML (all tags should be closed, all attributes should have values, all values should have quotes).
• Attribute values should use double quotes.

JavaScript

• Indent with tabs, NOT spaces.
• Variable and function names should be in camelCase.
• Constant names should be ALL_CAPS_SEPARATED_BY_UNDERSCORES.
• Surround operators with spaces.
• Braces should open on the same line as control structures (if, for, try, etc.), NOT on the next line.
• The code block within a control structure (if, for, try, etc.) should be indented one additional level and not on the same line as the control structure.

Credits

• The site uses a Python backend running on Google App Engine.
• Original website created, designed, and coded by Zachary Yaro, maintained by STAR Webmaster Committee.
• Design inspired by LCARS from Star Trek: The Next Generation.
• Python Markdown implementation created by Waylan Limberg.
• GitHub-Flavored Markdown Python implementation by Christian Oudard, mvasilkov, and Matt Westcott.