mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-13 22:41:32 -05:00

History

Sebastian Gierlinger 40c78493a3 Password change MU closes #4624 - added user_id to password reset request - hide old password field - updated changePassword method to check permissions - updated changePassword method to work without oldPassword - fixed bug for errors shown as [Object object]		2014-12-11 21:23:07 +01:00
..
adapters
assets	Fix settings header to allow dropdown menus to work	2014-12-04 19:25:14 +02:00
components	gh-trim-focus-input autofocus fix for iOS Safari	2014-12-02 09:14:32 -08:00
controllers	Add Tag Meta View	2014-12-10 18:12:30 +00:00
docs
helpers	Adds markdown highlight support	2014-12-04 13:37:29 +00:00
html	Add XSL for Sitemaps	2014-12-04 09:38:09 +00:00
initializers	Update authentication initializer.	2014-12-04 15:09:11 +00:00
mixins	Add Tag Meta View	2014-12-10 18:12:30 +00:00
models	Password change MU	2014-12-11 21:23:07 +01:00
routes	Merge pull request #4523 from Gargol/issue-4516	2014-12-08 11:45:48 -07:00
serializers
templates	Password change MU	2014-12-11 21:23:07 +01:00
transforms
utils	Adds ctrl/cmd+s shortcut to whole application with a noop default	2014-12-08 19:08:40 +01:00
validators	Add Tag Meta View	2014-12-10 18:12:30 +00:00
views	adds code injection admin frontend implementation, handlebar helpers + settings	2014-12-04 04:16:08 +00:00
.jshintrc	Miscellaneous client cleanup	2014-11-29 02:42:08 +00:00
_config.yml
app.js
config-dev.js
config-prod.js
loader.js	Add initial client unit test.	2014-11-26 23:20:50 -05:00
README.md	Miscellaneous client cleanup	2014-11-29 02:42:08 +00:00
router.js	adds code injection admin frontend implementation, handlebar helpers + settings	2014-12-04 04:16:08 +00:00

README.md

Ghost Admin Client

Ember.js application used as a client-side admin for the Ghost blogging platform. This readme is a work in progress guide aimed at explaining the specific nuances of the Ghost Ember app to contributors whose main focus is on this side of things.

Architecture

ToDo: Explain the basic Ember app structure.

client/
├── assets/
│   ├── ghost.css
│   └── ghost.min.css
├── things/
│   ├── things.js
│   └── things.min.js
└── things/
    ├── things.js
    └── things.js

SASS

All CSS is written in SASS and compiled using grunt. We do not follow any strict CSS framework, however our general style is pretty similar to BEM.

Styles are primarily broken up into 4 main categories:

Helpers - are pure-sass files. Variables/mixins/things which are generally never compiled to actual CSS, and are simply used to aid development.
Patterns - are base level visual styles for HTML elements (eg. Buttons)
Components - are groups of patterns used to create a UI component (eg. Modals)
Layouts - are groups of components used to create application screens (eg. Settings)
Lib - is where we store styles for 3rd party components.

All of these separate files are subsequently imported and compiled in screen.scss.

Front End Standards

4 spaces for HTML & CSS indentation. Never tabs.
Double quotes only, never single quotes.
Use tags and elements appropriate for an HTML5 doctype (including self-closing tags)
Adhere to the Recess CSS property order.
Always a space after a property's colon (.e.g, display: block; and not display:block;).
End all lines with a semi-colon.
For multiple, comma-separated selectors, place each selector on its own line.
Use js- prefixed classes for JavaScript hooks into the DOM, and never use these in CSS as per Slightly Obtrusive JavaSript
Avoid SASS over-nesting. Never nest more than 3 levels deep.
Use comments to explain "why" not "what" (Eg. This requires a z-index in order to appear above mobile navigation. Not: This is a thing which is always on top!)