Skip to content

WikiToLearn/WikiToLearnSkin

Repository files navigation

WikiToLearnSkin

A custom Mediawiki skin for WikiToLearn

Folder structure

  • /build/, compiled and ready for production files

  • /styles/, for Sass files

    • skin.scss, the heart of the skin, keep it clean!
    • base/, contains global styles, such as resets, typography, colors, etc.
    • layout/, contains styling for larger layout components; e.g. nav, header, footer, etc.
    • components/, contains each self-contained component
    • pages/, contains page-specific styling, if necessary
    • utils/, contains global mixins, functions, helper selectors, etc.
    • From here
  • /scripts/, JS scripts

  • /images/, static images needed by the skin

  • /i18n/, localization files

Developing

To start with a fresh clone of the repo you need to:

  • npm install --dev
    • This will install 'gulp' and the required submodules
  • bower install
    • This will install bower dependencies

To watch and compile the assets:

  • gulp sass
    • This will build the style
  • gulp watch
    • This will listen for every changes in the styles folder and will compile it to plain css when files are saved.

Further documentation on the skin can be found here