mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-01 13:54:35 +03:00

History

Hannah Wolfe a196d81778 Fixing overzealous trailing-slashes refs #4989 - Don't add a trailing a slash if the url is a file or anchor		2015-03-07 21:09:50 +00:00
..
adapters	Make embedded-relation-adapter the default	2014-12-28 00:28:36 +00:00
assets	Merge pull request #4948 from PaulAdamDavis/simpler-icon-code	2015-03-07 20:16:06 +02:00
components	Validate urls in modal	2015-02-28 16:24:34 +00:00
controllers	Fixing overzealous trailing-slashes	2015-03-07 21:09:50 +00:00
docs	Implement popovers	2014-10-20 22:09:45 +01:00
helpers	Update Ember to 1.10.0	2015-02-09 16:20:16 +00:00
html	Implement Navigation item input behaviors	2015-01-18 23:08:03 -06:00
initializers	Rework Labs feature toggling	2015-01-04 20:05:25 +00:00
mixins	Mark html notifications as html-safe, else escape	2015-02-28 16:22:38 +00:00
models	Navigation UI Ember Integration	2015-01-11 20:04:01 +00:00
routes	More serverside notificaiton HTML fixes	2015-03-03 19:57:27 +00:00
serializers	Update Ember-Data, remove unneeded code	2015-01-25 20:00:55 +00:00
templates	Remove button wrapping blog logo image	2015-03-02 14:53:03 +00:00
transforms	Changed ember models to use moment for dates	2014-06-05 10:30:28 -06:00
utils	Display serverside HTML notifications correctly	2015-02-28 17:41:38 +00:00
validators	Add Tag Meta View	2014-12-10 18:12:30 +00:00
views	Simplify navigation item reordering	2015-02-25 17:26:25 +00:00
_config.yml	Adding Grunt tasks for Sass	2014-08-31 14:16:58 +01:00
.jshintrc	Remove jshint rules that are no longer supported	2015-01-23 21:00:37 +00:00
app.js	Update grunt-jscs dependency	2015-01-16 18:06:20 +00:00
config-dev.js	Get Ember Admin ready for production	2014-07-22 22:33:49 +00:00
config-prod.js	Get Ember Admin ready for production	2014-07-22 22:33:49 +00:00
loader.js	Update grunt-jscs dependency	2015-01-16 18:06:20 +00:00
README.md	Miscellaneous client cleanup	2014-11-29 02:42:08 +00:00
router.js	Navigation UI Ember Integration	2015-01-11 20:04:01 +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!)