mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-29 13:52:10 +03:00

History

Hannah Wolfe 5b9ff9e58f Move tag management from behind config/labs flags issue #4248 - tag management is ready for release, this takes the training wheels off :) - remove config flag - remove labs checkbox and related code		2015-01-06 18:56:42 +00:00
..
adapters	Make embedded-relation-adapter the default	2014-12-28 00:28:36 +00:00
assets	Merge pull request #4711 from JohnONolan/fix-tagmgmt	2014-12-23 12:22:54 +00:00
components	Use an explicit action name in action helper	2014-12-26 16:01:50 +00:00
controllers	Move tag management from behind config/labs flags	2015-01-06 18:56:42 +00:00
docs	Implement popovers	2014-10-20 22:09:45 +01:00
helpers	Allow resolver to lookup gh-path helper.	2014-12-31 14:44:39 -05:00
html	Navigation UI Mockup	2014-12-17 21:43:44 +00:00
initializers	Rework Labs feature toggling	2015-01-04 20:05:25 +00:00
mixins	Remove ObjectController proxying behavior.	2015-01-01 21:51:20 -05:00
models	Merge pull request #4750 from ErisDS/labs-thing	2015-01-04 13:44:47 -06:00
routes	Move tag management from behind config/labs flags	2015-01-06 18:56:42 +00:00
serializers	Finish tag post count UI. Misc tag related fixes	2014-12-22 02:17:18 +00:00
templates	Move tag management from behind config/labs flags	2015-01-06 18:56:42 +00:00
transforms	Changed ember models to use moment for dates	2014-06-05 10:30:28 -06:00
utils	Rework Labs feature toggling	2015-01-04 20:05:25 +00:00
validators	Add Tag Meta View	2014-12-10 18:12:30 +00:00
views	Remove ObjectController proxying behavior.	2015-01-01 21:51:20 -05:00
_config.yml	Adding Grunt tasks for Sass	2014-08-31 14:16:58 +01:00
.jshintrc	Miscellaneous client cleanup	2014-11-29 02:42:08 +00:00
app.js	Allow resolver to lookup gh-path helper.	2014-12-31 14:44:39 -05: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	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!)