Skip to content

Commit

Permalink
SAK-30439 Documentation update
Browse files Browse the repository at this point in the history
Also forgot to add the compressed and ul default in last commit.
  • Loading branch information
ern committed Mar 4, 2016
1 parent 7bb970c commit df1df73
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 20 deletions.
4 changes: 3 additions & 1 deletion reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
```mvn clean install -Dsakai.skin.customization.file=/folder/to/your/file.scss```

***Note the profile ```-P compile-skin``` is active by default and need not be added as a command line option.***

More commands are listed here: *[https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/compile-skin.md](https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/compile-skin.md)*


Expand Down Expand Up @@ -62,7 +64,7 @@ NOTE: Any changes or additions in one section should be changed or added in othe

3. All necessary documentation related to the variables is located at the variable definition itself.

* **More involved:** Explaining SASS and compass and Morpheus folder structure ( [https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md](https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md) )
* **More involved:** Explaining SASS and Morpheus folder structure ( [https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md](https://github.com/sakaiproject/sakai/blob/master/reference/library/src/morpheus-master/customization-tool.md) )

1. Tool customizations:

Expand Down
2 changes: 1 addition & 1 deletion reference/library/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@
</execution>
</executions>
<configuration>
<outputStyle>nested</outputStyle>
<outputStyle>compressed</outputStyle>
<imgPath>${basedir}/src/${sakai.skin.source}/images/</imgPath>
<inputPath>${basedir}/src/${sakai.skin.source}/sass/</inputPath>
<outputPath>${basedir}/src/webapp/skin/${sakai.skin.target}</outputPath>
Expand Down
2 changes: 0 additions & 2 deletions reference/library/src/morpheus-master/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Morpheus update

We have removed external gems to Compass. By now, just with Compass we can do all the responsive design and RTL support for the skins.

## New folder structure

We have thought about a new folder and files structure for Morpheus (beyond the user experience),
Expand Down
8 changes: 1 addition & 7 deletions reference/library/src/morpheus-master/compile-skin.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,4 @@ We have uploaded a non-icons version compiled by:

`mvn clean install -Dsakai.skin.target=morpheus-default-noicons -Dsakai.skin.customization.file=./src/morpheus-master/sass/examples/_customization_example_withouticons.scss`

Feel free to repeat this commands to generate as many skins as you want.

## I want to design my skin from scratch using morpheus

You can use and test your own compass instalation to generate skins by typing inside morpheus-master folder:

`compass compile --css-dir=../webapp/skin/morpheus-custom --http-path=/library/skin/morpheus-custom`
Feel free to repeat this commands to generate as many skins as you want.
10 changes: 1 addition & 9 deletions reference/library/src/morpheus-master/customization-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The new skin of Sakai is made on SASS. SASS (**S**yntactically **A**wesome **S**tyle **S**heets) is just a CSS preprocessor which give us many tools and functions to make our work easier.

## Why SASS (and Compass)?
## Why SASS?

**Variables:**

Expand Down Expand Up @@ -56,14 +56,6 @@ You'll notice that the *ul*, *li*, and *a* selectors are nested inside the nav s
text-decoration: none;
}

## Compass?

Compass is a SASS framework that gives you full support for browsers. For example, if we want to add a *transform* to a div, we don't need to add all vendor prefixes, just:

@include transform( rotate(-135deg) skew(-10deg, -10deg) );

Full Documentation is here: http://compass-style.org/reference/compass/

## What should I do with a tool

In morpheus-master, we have created a folder structure to try to make the design customization cleaner and also to clarify the development process on Sakai. For example, tool customization scss files should be on **/morpheus-master/sass/modules/tool/tool-name**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,3 +167,8 @@ button[class="disabled"]:hover,
cursor: not-allowed;
text-decoration: none;
}

ul, ol {
list-style: none;
padding: 0 0 0 0;
}

0 comments on commit df1df73

Please sign in to comment.