diff options
New Docs category pages
8 files changed, 538 insertions, 67 deletions
| -rw-r--r-- | docs/src/components.pug | 184 | ||||
| -rw-r--r-- | docs/src/components/tiles.pug | 10 | ||||
| -rw-r--r-- | docs/src/elements.pug | 82 | ||||
| -rw-r--r-- | docs/src/experimentals.pug | 105 | ||||
| -rw-r--r-- | docs/src/getting-started.pug | 78 | ||||
| -rw-r--r-- | docs/src/layout.pug | 45 | ||||
| -rw-r--r-- | docs/src/utilities.pug | 99 | ||||
| -rw-r--r-- | docs/src/utilities/shapes.pug | 2 |
diff --git a/docs/src/components.pug b/docs/src/components.pug index 539bbc2..fa7d1cd 100644 --- a/docs/src/components.pug +++ b/docs/src/components.pug @@ -3,9 +3,191 @@ extends _layout/_docs-layout.pug block variables - var slug = 'components' - var parent = 'components' - - var title = 'Components - Spectre.css CSS Framework' + - var title = 'components - Spectre.css CSS Framework' - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content + +docs-heading('components', 'Components') + include _layout/_ad-g.pug + + p + strong Spectre.css + | is a lightweight, responsive and modern CSS framework for faster and extensible development. + p + | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. + + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Accordions + .card-body + | Used to toggle sections of content + .card-footer + a.btn.btn-primary(href="components/accordions.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Avatars + .card-body + | User profile pictures + .card-footer + a.btn.btn-primary(href="components/avatars.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Badges + .card-body + | Used as unread number indicators + .card-footer + a.btn.btn-primary(href="components/badges.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Bars + .card-body + | Progress of a task or the value within the known range + .card-footer + a.btn.btn-primary(href="components/bars.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Breadcrumbs + .card-body + | Navigational hierarchies to indicate current location + .card-footer + a.btn.btn-primary(href="components/breadcrumbs.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Cards + .card-body + | Flexible content containers + .card-footer + a.btn.btn-primary(href="components/cards.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Chips + .card-body + | Complex entities in small blocks + .card-footer + a.btn.btn-primary(href="components/chips.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Empty states + .card-body + | Navigational hierarchies to indicate current location + .card-footer + a.btn.btn-primary(href="components/empty.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Menu + .card-body + | Vertical list of links or buttons for actions and navigation + .card-footer + a.btn.btn-primary(href="components/menu.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Modals + .card-body + | Flexible dialog prompts + .card-footer + a.btn.btn-primary(href="components/modals.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Nav + .card-body + | Vertical list of links + .card-footer + a.btn.btn-primary(href="components/nav.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Pagination + .card-body + | Vertical list of links or buttons for actions and navigation + .card-footer + a.btn.btn-primary(href="components/pagination.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Panels + .card-body + | Flexible view container with auto-expand content section + .card-footer + a.btn.btn-primary(href="components/panels.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Popovers + .card-body + | Small overlay content containers + .card-footer + a.btn.btn-primary(href="components/popovers.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Steps + .card-body + | Progress indicators of a sequence of task steps + .card-footer + a.btn.btn-primary(href="components/steps.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Tabs + .card-body + | Switch between different views + .card-footer + a.btn.btn-primary(href="components/tabs.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Tiles + .card-body + | Repeatable or embeddable information blocks + .card-footer + a.btn.btn-primary(href="components/tiles.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Toasts + .card-body + | Progress indicators of a sequence of task steps + .card-footer + a.btn.btn-primary(href="components/toasts.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Tooltips + .card-body + | Context information labels that appear on hover and focus + .card-footer + a.btn.btn-primary(href="components/tooltips.html") View + + include _layout/_ad-c.pug include _layout/_footer.pug
\ No newline at end of file diff --git a/docs/src/components/tiles.pug b/docs/src/components/tiles.pug index 25bd042..a2e8827 100644 --- a/docs/src/components/tiles.pug +++ b/docs/src/components/tiles.pug @@ -20,7 +20,7 @@ block docs-content img(src="../img/avatar-3.png" alt="Avatar") .tile-content p.tile-title The Avengers - p.tile-subtitle.text-gray + p.tile-subtitle | Earth's Mightiest Heroes joined forces to take on threats that were too big for any one hero to tackle... .tile-action button.btn.btn-primary Join @@ -32,7 +32,7 @@ block docs-content img(src="../img/avatar-2.png" alt="Avatar") .tile-content p.tile-title The S.H.I.E.L.D. - p.tile-subtitle.text-gray The Strategic Homeland Intervention, Enforcement, and Logistics Division... + p.tile-subtitle The Strategic Homeland Intervention, Enforcement, and Logistics Division... p button.btn.btn-primary.btn-sm Join button.btn.btn-sm Contact @@ -55,7 +55,7 @@ block docs-content </div> <div class="tile-content"> <p class="tile-title">The Avengers</p> - <p class="tile-subtitle text-gray">Earth's Mightiest Heroes joined forces to take on threats that were too big for any one hero to tackle...</p> + <p class="tile-subtitle">Earth's Mightiest Heroes joined forces to take on threats that were too big for any one hero to tackle...</p> </div> <div class="tile-action"> <button class="btn btn-primary">Join</button> @@ -78,7 +78,7 @@ block docs-content i.icon.icon-mail.centered .tile-content .tile-title spectre-docs.pdf - .tile-subtitle.text-gray 14MB · Public · 1 Jan, 2017 + small.tile-subtitle.text-gray 14MB · Public · 1 Jan, 2017 .tile-action button.btn.btn-link.btn-action i.icon.icon-more-vert @@ -94,7 +94,7 @@ block docs-content </div> <div class="tile-content"> <div class="tile-title">spectre-docs.pdf</div> - <div class="tile-subtitle text-gray">14MB · Public · 1 Jan, 2017</div> + <small class="tile-subtitle text-gray">14MB · Public · 1 Jan, 2017</small> </div> <div class="tile-action"> <button class="btn btn-link"> diff --git a/docs/src/elements.pug b/docs/src/elements.pug index 8061827..270cc39 100644 --- a/docs/src/elements.pug +++ b/docs/src/elements.pug @@ -7,6 +7,88 @@ block variables - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content + +docs-heading('elements', 'Elements') + include _layout/_ad-g.pug + p + strong Spectre.css + | is a lightweight, responsive and modern CSS framework for faster and extensible development. + p + | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. + + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Typography + .card-body + | Headings, paragraphs, semantic text, blockquote and lists elements + .card-footer + a.btn.btn-primary(href="elements/typography.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Tables + .card-body + | Tables and data sets + .card-footer + a.btn.btn-primary(href="elements/tables.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Buttons + .card-body + | Simple button styles for actions in different types and sizes + .card-footer + a.btn.btn-primary(href="elements/buttons.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Forms + .card-body + | Input, textarea, select, checkbox, radio and switch + .card-footer + a.btn.btn-primary(href="elements/forms.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Icons + .card-body + | Single-element, responsive and pure CSS icons + .card-footer + a.btn.btn-primary(href="elements/icons.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Labels + .card-body + | Formatted text tags for highlighted, informative information + .card-footer + a.btn.btn-primary(href="elements/labels.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Code + .card-body + | Inline and multiline code snippets + .card-footer + a.btn.btn-primary(href="elements/code.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Media + .card-body + | Responsive images, figures and video + .card-footer + a.btn.btn-primary(href="elements/media.html") View + + include _layout/_ad-c.pug include _layout/_footer.pug
\ No newline at end of file diff --git a/docs/src/experimentals.pug b/docs/src/experimentals.pug index f2fb075..e1a6a02 100644 --- a/docs/src/experimentals.pug +++ b/docs/src/experimentals.pug @@ -7,13 +7,114 @@ block variables - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content - - //- Experimentals +docs-heading('experimentals', 'Experimentals') + include _layout/_ad-g.pug + p | The Experimentals include experimental elements and features, mostly are not yet ready for wide use. | These elements and components are limited inside #[code spectre-exp.scss] before browsers fully support them. | Sometimes, there are some specific browsers targeted components. + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Autocomplete + .card-body + | Form component provides suggestions while you type + .card-footer + a.btn.btn-primary(href="experimentals/autocomplete.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Calendars + .card-body + | Date or date range picker and events display based on Flexbox + .card-footer + a.btn.btn-primary(href="experimentals/calendars.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Carousels + .card-body + | Pure CSS slideshows for cycling images + .card-footer + a.btn.btn-primary(href="experimentals/carousels.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Comparison sliders + .card-body + | Pure CSS sliders for comparing two images + .card-footer + a.btn.btn-primary(href="experimentals/comparison.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Filters + .card-body + | CSS only content filters + .card-footer + a.btn.btn-primary(href="experimentals/filters.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Meters + .card-body + | Representing the value within the known range + .card-footer + a.btn.btn-primary(href="experimentals/meters.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Off-canvas + .card-body + | Navigation layout that sidebars can slide in and out of the viewport + .card-footer + a.btn.btn-primary(href="experimentals/off-canvas.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Parallax + .card-body + | Pure CSS Apple TV/tvOS hover parallax effect + .card-footer + a.btn.btn-primary(href="experimentals/parallax.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Progress + .card-body + | Indicating the progress completion of a task + .card-footer + a.btn.btn-primary(href="experimentals/progress.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Sliders + .card-body + | Selecting values from ranges + .card-footer + a.btn.btn-primary(href="experimentals/sliders.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Timelines + .card-body + | Ordered sequences of activities + .card-footer + a.btn.btn-primary(href="experimentals/timelines.html") View + + include _layout/_ad-c.pug include _layout/_footer.pug
\ No newline at end of file diff --git a/docs/src/getting-started.pug b/docs/src/getting-started.pug index d8e369d..21d93c1 100644 --- a/docs/src/getting-started.pug +++ b/docs/src/getting-started.pug @@ -7,37 +7,59 @@ block variables - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content - //- Introduction - +docs-heading('introduction', 'Introduction') + +docs-heading('getting-started', 'Getting started') + include _layout/_ad-g.pug + p - strong Spectre.css - | is a lightweight, responsive and modern CSS framework for faster and extensible development. + strong Spectre.css + | is a lightweight, responsive and modern CSS framework for faster and extensible development. p - | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. + | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. + + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Installation + .card-body + | How to install and use Spectre.css + .card-footer + a.btn.btn-primary(href="getting-started/installation.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Custom version + .card-body + | Customize your version of Spectre.css + .card-footer + a.btn.btn-primary(href="getting-started/custom.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Browser support + .card-body + | Browser compatibility and support + .card-footer + a.btn.btn-primary(href="getting-started/browsers.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 What's new + .card-body + | Changelog and release notes + .card-footer + a.btn.btn-primary(href="getting-started/whatsnew.html") View - .columns - .column - .tile.tile-centered - .tile-icon - .example-tile-icon - i.icon.icon-mail.centered - .tile-content - .tile-title spectre-docs.pdf - .tile-subtitle.text-gray 14MB · Public · 1 Jan, 2017 - .tile-action - button.btn.btn-link.btn-action - i.icon.icon-more-vert - .column - .tile.tile-centered - .tile-icon - .example-tile-icon - i.icon.icon-mail.centered - .tile-content - .tile-title spectre-docs.pdf - .tile-subtitle.text-gray 14MB · Public · 1 Jan, 2017 - .tile-action - button.btn.btn-link.btn-action - i.icon.icon-more-vert + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Accessibility + .card-body + | Coming soon + include _layout/_ad-c.pug include _layout/_footer.pug diff --git a/docs/src/layout.pug b/docs/src/layout.pug index ca6f5f5..582a98b 100644 --- a/docs/src/layout.pug +++ b/docs/src/layout.pug @@ -7,16 +7,43 @@ block variables - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content - //- Flexbox grid - + +docs-heading('layout', 'Layout') include _layout/_ad-g.pug - - //- Responsive - - include _layout/_ad-c.pug - //- Navbar - - include _layout/_ad-g.pug + p + strong Spectre.css + | is a lightweight, responsive and modern CSS framework for faster and extensible development. + p + | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. + + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Flexbox grid + .card-body + | Flexbox based responsive grid system with 12 columns + .card-footer + a.btn.btn-primary(href="layout/grid.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Responsive + .card-body + | Responsive layout grid system and responsive visibility utilities + .card-footer + a.btn.btn-primary(href="layout/responsive.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Navbar + .card-body + | Layout container that appears in the header of apps and websites + .card-footer + a.btn.btn-primary(href="layout/navbar.html") View + + include _layout/_ad-c.pug include _layout/_footer.pug
\ No newline at end of file diff --git a/docs/src/utilities.pug b/docs/src/utilities.pug index 8db439b..a7ef67e 100644 --- a/docs/src/utilities.pug +++ b/docs/src/utilities.pug @@ -7,31 +7,88 @@ block variables - var description = 'Spectre.css is a lightweight, responsive and modern CSS framework for faster and extensible development. Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language.' block docs-content - //- Colors - + +docs-heading('utilities', 'Utilities') include _layout/_ad-g.pug - - //- Cursor - - //- Display - - include _layout/_ad-c.pug + p + strong Spectre.css + | is a lightweight, responsive and modern CSS framework for faster and extensible development. + p + | Spectre provides basic styles for typography and elements, flexbox based responsive layout system, pure CSS components and utilities with best practice coding and consistent design language. - //- Divider - - - //- Loading - - include _layout/_ad-g.pug + .docs-demo.columns + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Color utilities + .card-body + | Colors for text, link and background + .card-footer + a.btn.btn-primary(href="utilities/colors.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Cursor utilities + .card-body + | Mouse cursor to display when mouseover + .card-footer + a.btn.btn-primary(href="utilities/cursors.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Display utilities + .card-body + | Display and hidden things + .card-footer + a.btn.btn-primary(href="utilities/display.html") View - //- Position - + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Divider + .card-body + | Separating elements + .card-footer + a.btn.btn-primary(href="utilities/divider.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Loading + .card-body + | Indicating loading or updating state + .card-footer + a.btn.btn-primary(href="utilities/loading.html") View - //- Shapes - - - //- Text - + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Position utilities + .card-body + | Useful layout and position things + .card-footer + a.btn.btn-primary(href="utilities/position.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Shape utilities + .card-body + | Changing element shapes + .card-footer + a.btn.btn-primary(href="utilities/shapes.html") View + + .column.col-6.col-xs-12 + .card + .card-header + .card-title.h5 Text utilities + .card-body + | Text alignment, styles and overflow things + .card-footer + a.btn.btn-primary(href="utilities/text.html") View + + include _layout/_ad-c.pug include _layout/_footer.pug
\ No newline at end of file diff --git a/docs/src/utilities/shapes.pug b/docs/src/utilities/shapes.pug index c445cfb..7449156 100644 --- a/docs/src/utilities/shapes.pug +++ b/docs/src/utilities/shapes.pug @@ -10,7 +10,7 @@ block docs-content +docs-heading('shapes', 'Shape utilities') include ../_layout/_ad-g.pug - p Shape utilities are used for change element shapes. + p Shape utilities are used for changing element shapes. .docs-demo.columns .column.col-6.text-center |