1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost-Admin.git synced 2023-12-14 02:33:04 +01:00
No description
Find a file
Matt Enlow 498c23a217 Create settings-menu-mixin for subview state tracking
Ref #4642
- Move duplicate code from PSM and SettingsTags to a mixin
2014-12-13 20:37:36 -07:00
adapters Enable JSCS checking on client. 2014-10-25 16:13:04 +00:00
assets Merge pull request #4632 from PaulAdamDavis/modal-colour-spacing 2014-12-12 09:49:05 -06:00
components Merge pull request #4613 from felixrieseberg/iss4506-2 2014-12-12 10:46:58 +00:00
controllers Create settings-menu-mixin for subview state tracking 2014-12-13 20:37:36 -07:00
docs Implement popovers 2014-10-20 22:09:45 +01:00
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 Create settings-menu-mixin for subview state tracking 2014-12-13 20:37:36 -07:00
models Merge pull request #4613 from felixrieseberg/iss4506-2 2014-12-12 10:46:58 +00:00
routes Merge pull request #4523 from Gargol/issue-4516 2014-12-08 11:45:48 -07:00
serializers Enable JSCS checking on client. 2014-10-25 16:13:04 +00:00
templates Merge pull request #4613 from felixrieseberg/iss4506-2 2014-12-12 10:46:58 +00:00
transforms Changed ember models to use moment for dates 2014-06-05 10:30:28 -06:00
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 Tag Cover Images 2014-12-10 17:48:18 -08:00
.jshintrc Miscellaneous client cleanup 2014-11-29 02:42:08 +00:00
_config.yml Adding Grunt tasks for Sass 2014-08-31 14:16:58 +01:00
app.js Rename helpers/ghostPaths.js -> helpers/ghost-paths.js 2014-09-24 20:06:42 -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

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!)