Skip to content

Commit

Permalink
Added GitHub Source links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tuckbarber committed Aug 8, 2019
1 parent f6b0d12 commit 3b15ed8
Show file tree
Hide file tree
Showing 42 changed files with 231 additions and 8 deletions.
4 changes: 3 additions & 1 deletion docs/base-base.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
title: Base
---

Modifies general type selectors for compatibility, best practices, and workarounds.
<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/base.css"></a>

Modifies general type selectors for compatibility, best practices, and workarounds.
___
## Affected Type Selectors

* `body`: Sets body background color as a best practice.
Expand Down
3 changes: 3 additions & 0 deletions docs/base-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
title: Code
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/code.css"></a>


Base styles for code blocks and preformmated text.

## Affected Type Selectors
Expand Down
3 changes: 3 additions & 0 deletions docs/base-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
title: Forms
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/forms.css"></a>


Modifies form type selectors for compatibility, best practices, and workarounds.

## Affected Type Selectors
Expand Down
2 changes: 2 additions & 0 deletions docs/base-print.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Print
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/print.css"></a>

Modifies general type selectors for best outcome when printing the page.

## Affected Type Selectors
Expand Down
3 changes: 3 additions & 0 deletions docs/base-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
title: Tables
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/tables.css"></a>


Modifies table type selectors for more uniform and customized styling.

## Affected Type Selectors
Expand Down
3 changes: 3 additions & 0 deletions docs/base-typography.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
title: Typography
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/base/typography.css"></a>


Modifies typographic type selectors for compatibility, best practices, and workarounds.

Note: This sets the <html> element's font-size to 62.5%, which
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-arrange.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: arrange
title: Arrange
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/arrange/arrange.css"></a>

<style>
.example-Child {
background-color: #329A5C;
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-breadcrumb.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: breadcrumb
title: Breadcrumb
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/breadcrumb/breadcrumb.css"></a>

Provides basic setup for breadcrumb navigation.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: button
title: Button
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/button/button.css"></a>

Provides a basic button template that includes a very basic default theme that
is ready to be extended.

Expand Down
2 changes: 2 additions & 0 deletions docs/comp-constrain.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: constrain
title: Constrain
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/constrain/constrain.css"></a>

<style>
.example-Parent{
display: inline-block;
Expand Down
3 changes: 3 additions & 0 deletions docs/comp-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: container
title: Container
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/container/container.css"></a>

<style>
.example-Parent{
border: 2px #bbb dashed;
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: content
title: Content
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/content/content.css"></a>

Container for main contain.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-flexembed.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: flexembed
title: FlexEmbed
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/flexembed/flexembed.css"></a>

<style>
.example-Parent{
width: 60%;
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ id: footer
title: Footer
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/footer/footer.css"></a>

A component for a footer. To be customized and styled.
9 changes: 9 additions & 0 deletions docs/comp-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ id: form
title: Form
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/"></a>

Provides custom styling for form fields and their various states.

## FormError
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/error.css"></a>

### Available classes

Expand Down Expand Up @@ -43,6 +46,7 @@ Provides custom styling for form fields and their various states.
</div>

## FormLabel
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/label.css"></a>

### Available classes

Expand Down Expand Up @@ -74,6 +78,7 @@ Provides custom styling for form fields and their various states.
</div>

## FormRequired
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/required.css"></a>

### Available Classes

Expand All @@ -99,6 +104,8 @@ Provides custom styling for form fields and their various states.

## FormSuccess

<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/success.css"></a>

### Available classes

* `FormSuccess`: Indicates that the form is successful.
Expand All @@ -122,6 +129,7 @@ Provides custom styling for form fields and their various states.
</div>

## SelectInput
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/selectmenu.css"></a>

Provides custom styles for select menu input fields.

Expand Down Expand Up @@ -216,6 +224,7 @@ Any `select` that is a child of a `.SelectInput` element will be styled.


## TextInput
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/form/textinput.css"></a>

Provides custom styling for text input fields and textareas.

Expand Down
2 changes: 2 additions & 0 deletions docs/comp-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: grid
title: Grid
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/grid/grid.css"></a>

<style>
.example-element {
background-color: #329A5C;
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ id: header
title: Header
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/header/header.css"></a>

A component for a header. To be customized and styled.
5 changes: 5 additions & 0 deletions docs/comp-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ id: image-component
title: Image
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/image/"></a>

Generic component that applies common treatments to `<img>` elements.

## Image
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/image/image.css"></a>

### Available classes

Expand Down Expand Up @@ -62,6 +65,7 @@ will limit the width of the image to 40% of the parent element to provide space
</div>

## Image Wrapper
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/image/wrapper.css"></a>

Provides styles to display an image on a page centered, floated left or floated
right along with other content like a caption.
Expand All @@ -82,6 +86,7 @@ right along with other content like a caption.
```

## Image Caption
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/image/caption.css"></a>

Provides styles for an image caption to be displayed below the image.

Expand Down
2 changes: 2 additions & 0 deletions docs/comp-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: list
title: List
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/list/list.css"></a>

Generic list component that applies common treatments to `<ul>` and
`<ol>` elements.

Expand Down
1 change: 1 addition & 0 deletions docs/comp-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: media
title: Media
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/media/media.css"></a>

The [media object](http://www.stubbornella.org/content/2010/06/25/the-media-object-saves-hundreds-of-lines-of-code/)
is an abstract element used as the basis for building more complex and
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: message
title: Message
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/message/message.css"></a>

### Available classes

* `Message`: The core message component.
Expand Down
12 changes: 10 additions & 2 deletions docs/comp-nav.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ id: navigation
title: Navigation
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation"></a>

## Dropdown
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/dropdown.css"></a>

Base structure for dropdown menus. Can easily be extended and / or themed.

Expand Down Expand Up @@ -147,7 +150,9 @@ Using is-last on last dropdown

</div>


## FooterNav
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/footer.css"></a>

A navigation menu for the footer of the page.

Expand All @@ -162,8 +167,8 @@ A navigation menu for the footer of the page.
* `is-current` / `is-currentParent`: When applied to menu item the item will be styled to stand out
from the other items.


## MainNav
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/mainnav.css"></a>

Base structure for main navigation menus. Can easily be extended and / or
themed.
Expand Down Expand Up @@ -221,6 +226,7 @@ Basic use:
```

## NavBar
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/bar.css"></a>

The bar to hold main navigation, contains `MainNav`.

Expand All @@ -229,6 +235,7 @@ The bar to hold main navigation, contains `MainNav`.
* `NavBar`: Applied to the parent element of `MainNav`.

## SidebarNav
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/sidebar.css"></a>

### Available classes

Expand All @@ -241,8 +248,9 @@ The bar to hold main navigation, contains `MainNav`.
* `is-current` / `is-currentParent`: When applied to menu item the item will be styled to stand out
from the other items.


## SmScBtn
<a class="sourceView-section" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/navigation/small-screen-button.css"></a>

A button to expand/compact navigation menu for smaller displays.

Expand Down
2 changes: 2 additions & 0 deletions docs/comp-pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: pagination
title: Pagination
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/pagination/pagination.css"></a>

Pagination for iterative pages.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/comp-triangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: triangle
title: Triangle
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/components/triangle/triangle.css"></a>

A simple inline CSS triangle that scales with font size. Must be used with
one and only one direction modifier.

Expand Down
2 changes: 2 additions & 0 deletions docs/util-align.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Align
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/align/align.css"></a>

<style>
.example-parent {
border: 2px #bbb solid;
Expand Down
2 changes: 2 additions & 0 deletions docs/util-background.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@
title: Background
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/background/background.css"></a>

Utility for the background color of elements.
2 changes: 2 additions & 0 deletions docs/util-display.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Display
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/display/display.css"></a>

Utility to control the `display` property.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/util-flex.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Flex
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/flex/flex.css"></a>

Applies to flex container

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/util-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Image
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/image/image.css"></a>

To be applied to images for general sizing and positioning.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/util-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Layout
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/layout/layout.css"></a>

To help with layout bugs and tricks.

## Available classes
Expand Down
2 changes: 2 additions & 0 deletions docs/util-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
title: Link
---

<a class="sourceView-page" href="https://github.com/aptuitiv/cacao/blob/master/src/css/utils/link/link.css"></a>

To be used with links to provide more functionality and alterations.

## Available classes
Expand Down
Loading

0 comments on commit 3b15ed8

Please sign in to comment.