Skip to content

Commit

Permalink
Tidied up readme.md ready for release
Browse files Browse the repository at this point in the history
  • Loading branch information
bencoveney committed Feb 20, 2016
1 parent baf870b commit 3447c2c
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 24 deletions.
2 changes: 1 addition & 1 deletion dist/MilligridExtended.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 25 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# Milligrid
# Milligrid:

Milligrid is a CSS grid system build using flexbox and Sass. You can view it in action [here](http://bencoveney.github.io/Milligrid). It is based on the [milligram](https://github.com/milligram/milligram) library.
Milligrid is a responsive CSS grid system which uses flexbox as a basis for its layout. It is based on the excellent grid built into [Milligram](https://milligram.github.io), which was in turn based on work by [Philip Walton](http://philipwalton.github.io/solved-by-flexbox/demos/grids/). Milligrid aims to take the brilliant Milligram grid and provide it in a standalone package with enhanced configuration options in the form of Sass variables.

## Planned features:
[Complete documentation](http://bencoveney.github.io/Milligrid/) is available for information on how best to utilise the grid system.

## Versions

### Milligrid.css
The core of Milligrid, this stylesheet includes only the grid styling with the default options.

### MilligridExtended.css - Incomplete!
Includes the core Milligram grid system and some additional text styling options. This is under development and should be used with caution.

+ Additional text element styles.
+ Configurable vertical flow.
+ Publish of package to bower (and other) platforms.
### *.scss
The .scss Sass source code files. These can be configured using the variables or ripped up and re-used however best suits your needs.

## Release History:

### v1.0.0 - 20/02/2016
+ Initial release.
+ Complete grid system.
+ Very basic text styling.

## Planned features:
+ Responsive utility classes (lg, md, sm, xs).
+ A More complete set of text element styles.
+ Configurable vertical rhythm.
6 changes: 5 additions & 1 deletion src/_Page.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// Wrapper element for a container.
// Gives large header styling.
.header {
background-color: #9b4dca;/* Permalink - use to edit and share this gradient: http://colorzilla.com/gradient-editor/#9b4dca+0,7db9e8+100 */
background-color: #9b4dca;
background: linear-gradient(to bottom, #9b4dca 0%,#793d9e 100%);
color: white;
padding: 9.6rem 0;
Expand All @@ -16,6 +18,8 @@
}
}

// Wrapper element for a container.
// Gives full width muted footer styling.
.footer {
background-color: #eeeeee;
color: #777777;
Expand Down
26 changes: 10 additions & 16 deletions src/_Text.scss
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ body {
color: $text-color;
}

// Reset options
*,
*:after,
*:before {
Expand All @@ -25,14 +26,15 @@ body {
line-height: 1.6;
}

// Link styling
a:link, a:visited, a:hover, a:active {
color: $highlight-color;
}

a:hover {
text-decoration: none;
}

// Header styling
h1 {
font-size: 3rem;
font-family: 'Lobster', cursive;
Expand All @@ -42,59 +44,51 @@ h1 {
margin: 2.4rem 0 - $gutter-width 2.3rem 0 - $gutter-width;
padding: 0 $gutter-width;
}

h2, h3, h4, h5, h6 {
display: inline-block; // Prevent margins collapsing.
min-width: 100%;
}

h2 {
margin-top: 1.3rem;
font-size: 2.2rem;
}

h3 {
margin-top: 1.6rem;
font-size: 2rem;
}

h4 {
margin-top: 2rem;
font-size: 1.8rem;
}

h5 {
margin-top: 2.3rem;
font-size: 1.6rem;
}

h6 {
margin-top: 1.3rem;
font-size: 1.4rem;
}

@mixin code-font {
font-family: 'Roboto Mono', Consolas, Courier New, Courier, monospace;
background-color: $text-color;
color: $shaded-background-color;
}

// List styling
ul {
margin-top: 1.2rem;
margin-bottom: 1.2rem;
margin-left: $gutter-width * 3
}

/* Inline code */
// Code styling, both inline and multi-line
@mixin code-font {
font-family: 'Roboto Mono', Consolas, Courier New, Courier, monospace;
background-color: $text-color;
color: $shaded-background-color;
}
code {
@include code-font;

font-size: 1.3rem;
padding: 0 0.2rem;
border-radius: 0.3rem;
}

/* Multi-line code */
pre{
@include code-font;

Expand Down
2 changes: 2 additions & 0 deletions src/_Variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ $maximum-items-per-row: 12 !default;
// The point in the screen's width at which all columns will become rows themselves.
$columns-as-rows-threshold: 40rem !default;

// MilligridExtended options:

// The color for standard body text
$text-color: #222222 !default;

Expand Down

0 comments on commit 3447c2c

Please sign in to comment.