From 3ab3a9d09955772ec56ddadbba49954b4edd6a3e Mon Sep 17 00:00:00 2001 From: Yan Zhu Date: Tue, 6 Nov 2018 18:52:37 +0800 Subject: Update the Docs completely --- docs/src/_layout/_ad-c.pug | 3 ++ docs/src/_layout/_ad-g.pug | 13 +++++ docs/src/_layout/_docs-layout.pug | 106 ++++++++++++++++++++++++++++++++++++++ docs/src/_layout/_footer.pug | 19 +++++++ docs/src/_layout/_layout.pug | 57 ++++++++++++++++++++ docs/src/_layout/_mixins.pug | 25 +++++++++ 6 files changed, 223 insertions(+) create mode 100644 docs/src/_layout/_ad-c.pug create mode 100644 docs/src/_layout/_ad-g.pug create mode 100644 docs/src/_layout/_docs-layout.pug create mode 100644 docs/src/_layout/_footer.pug create mode 100644 docs/src/_layout/_layout.pug create mode 100644 docs/src/_layout/_mixins.pug (limited to 'docs/src/_layout') diff --git a/docs/src/_layout/_ad-c.pug b/docs/src/_layout/_ad-c.pug new file mode 100644 index 0000000..79b3e2c --- /dev/null +++ b/docs/src/_layout/_ad-c.pug @@ -0,0 +1,3 @@ +block ad-carbons + .docs-ad.docs-ad-sidebar.text-center + script#_carbonads_js(async="" type="text/javascript" src="https://cdn.carbonads.com/carbon.js?serve=CK7DTKQW&placement=picturepan2githubio") \ No newline at end of file diff --git a/docs/src/_layout/_ad-g.pug b/docs/src/_layout/_ad-g.pug new file mode 100644 index 0000000..c227ea8 --- /dev/null +++ b/docs/src/_layout/_ad-g.pug @@ -0,0 +1,13 @@ +block ad-adsense + .docs-ad + .hide-md.text-center + script(async='', src='https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js') + // GitHub-lg + ins.adsbygoogle.mx-auto(style='display:inline-block;width:728px;height:90px', data-ad-client='ca-pub-2225124559530218', data-ad-slot='9894180784') + script. + (adsbygoogle = window.adsbygoogle || []).push({}); + .show-md.text-center + // GitHub-sm + ins.adsbygoogle(style='display:inline-block;width:300px;height:250px', data-ad-client='ca-pub-2225124559530218', data-ad-slot='9278881734') + script. + (adsbygoogle = window.adsbygoogle || []).push({}); \ No newline at end of file diff --git a/docs/src/_layout/_docs-layout.pug b/docs/src/_layout/_docs-layout.pug new file mode 100644 index 0000000..a935fc1 --- /dev/null +++ b/docs/src/_layout/_docs-layout.pug @@ -0,0 +1,106 @@ +extends _layout.pug +include _mixins.pug + +block content + .docs-container.off-canvas.off-canvas-sidebar-show + .docs-navbar + a.off-canvas-toggle.btn.btn-link.btn-action(href='#sidebar') + i.icon.icon-menu + .btns + a.btn.btn-primary.float-right(href='https://github.com/picturepan2/spectre' target='_blank') GitHub + a.btn.mr-1.float-right(href='https://www.paypal.me/picturepan2' target='_blank') Sponsor + + #sidebar.docs-sidebar.off-canvas-sidebar + .docs-brand + if slug != parent + a.docs-logo(href='../index.html') + img(src='../img/spectre-logo.svg' alt='Spectre.css CSS Framework') + h2 SPECTRE + else + a.docs-logo(href='index.html') + img(src='img/spectre-logo.svg' alt='Spectre.css CSS Framework') + h2 SPECTRE + .docs-nav + .accordion-container + +docs-accordion( + 'getting-started', + 'Getting started', + {url: 'installation', name: 'Installation'}, + {url: 'custom', name: 'Custom version'}, + {url: 'browsers', name: 'Browser support'}, + {url: 'whatsnew', name: 'What\'s new'} + ) + +docs-accordion( + 'elements', + 'Elements', + {url: 'typography', name: 'Typography'}, + {url: 'tables', name: 'Tables'}, + {url: 'buttons', name: 'Buttons'}, + {url: 'forms', name: 'Forms'}, + {url: 'icons', name: 'Icons'}, + {url: 'labels', name: 'Labels'}, + {url: 'code', name: 'Code'}, + {url: 'media', name: 'Media'} + ) + +docs-accordion( + 'layout', + 'Layout', + {url: 'grid', name: 'Flexbox grid'}, + {url: 'responsive', name: 'Responsive'}, + {url: 'navbar', name: 'Navbar'} + ) + +docs-accordion( + 'components', + 'Components', + {url: 'accordions', name: 'Accordions'}, + {url: 'avatars', name: 'Avatars'}, + {url: 'badges', name: 'Badges'}, + {url: 'bars', name: 'Bars'}, + {url: 'breadcrumbs', name: 'Breadcrumbs'}, + {url: 'cards', name: 'Cards'}, + {url: 'chips', name: 'Chips'}, + {url: 'empty', name: 'Empty states'}, + {url: 'menu', name: 'Menu'}, + {url: 'modals', name: 'Modals'}, + {url: 'nav', name: 'Nav'}, + {url: 'pagination', name: 'Pagination'}, + {url: 'panels', name: 'Panels'}, + {url: 'popovers', name: 'Popovers'}, + {url: 'steps', name: 'Steps'}, + {url: 'tabs', name: 'Tabs'}, + {url: 'tiles', name: 'Tiles'}, + {url: 'toasts', name: 'Toasts'}, + {url: 'tooltips', name: 'Tooltips'} + ) + +docs-accordion( + 'utilities', + 'Utilities', + {url: 'colors', name: 'Colors'}, + {url: 'cursors', name: 'Cursors'}, + {url: 'display', name: 'Display'}, + {url: 'divider', name: 'Divider'}, + {url: 'loading', name: 'Loading'}, + {url: 'position', name: 'Position'}, + {url: 'shapes', name: 'Shapes'}, + {url: 'text', name: 'Text'} + ) + +docs-accordion( + 'experimentals', + 'Experimentals', + {url: 'autocomplete', name: 'Autocomplete'}, + {url: 'calendars', name: 'Calendars'}, + {url: 'carousels', name: 'Carousels'}, + {url: 'comparison', name: 'Comparison sliders'}, + {url: 'filters', name: 'Filters'}, + {url: 'meters', name: 'Meters'}, + {url: 'off-canvas', name: 'Off-canvas'}, + {url: 'parallax', name: 'Parallax'}, + {url: 'progress', name: 'Progress'}, + {url: 'sliders', name: 'Sliders'}, + {url: 'timelines', name: 'Timelines'} + ) + + a.off-canvas-overlay(href='#close') + .off-canvas-content + #content.docs-content + block docs-content \ No newline at end of file diff --git a/docs/src/_layout/_footer.pug b/docs/src/_layout/_footer.pug new file mode 100644 index 0000000..82a5b2e --- /dev/null +++ b/docs/src/_layout/_footer.pug @@ -0,0 +1,19 @@ +#copyright.docs-footer.container.grid-lg + p + a(href='getting-started.html' target='_blank') Documents + | · + a(href='https://github.com/picturepan2/spectre' target='_blank') GitHub + | · + a(href='https://twitter.com/spectrecss' target='_blank') Twitter + | · + a(href='https://www.paypal.me/picturepan2' target='_blank') PayPal Donate + | · Version + span.version + p + | Designed and built with + span.text-error ♥ + | by + a(href='https://twitter.com/picturepan2' target='_blank') Yan Zhu + | . Licensed under the + a(href='https://github.com/picturepan2/spectre/blob/master/LICENSE' target='_blank') MIT License + | . \ No newline at end of file diff --git a/docs/src/_layout/_layout.pug b/docs/src/_layout/_layout.pug new file mode 100644 index 0000000..53dca0e --- /dev/null +++ b/docs/src/_layout/_layout.pug @@ -0,0 +1,57 @@ +block global + - var domain = 'https://picturepan2.github.io/spectre/' + - var url = domain + +block variables + - var slug = '' + - var parent = '' + - var title = 'Spectre.css - A Lightweight, Responsive and Modern 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.' + +if slug == parent + if slug == 'index' + - var url = domain + else + - var url = domain + slug + '.html' +else + - var url = domain + parent + '/' + slug + '.html' + +doctype html +html(lang='en') + head + title= title + meta(charset='utf-8') + meta(name='robots' content='index, follow') + meta(name='viewport' content='width=device-width, initial-scale=1.0, shrink-to-fit=no') + meta(http-equiv='x-ua-compatible' content='ie=edge') + meta(name='description' content= description) + meta(name='author' content='Yan Zhu') + if slug != parent + link(rel='shortcut icon' href='../img/favicons/favicon.ico') + link(rel='icon' href='../img/favicons/favicon.png') + link(rel='stylesheet' href='../dist/spectre.min.css') + link(rel='stylesheet' href='../dist/spectre-icons.min.css') + link(rel='stylesheet' href='../dist/spectre-exp.min.css') + link(rel='stylesheet' href='../dist/docs.min.css') + else + link(rel='shortcut icon' href='img/favicons/favicon.ico') + link(rel='icon' href='img/favicons/favicon.png') + link(rel='stylesheet' href='dist/spectre.min.css') + link(rel='stylesheet' href='dist/spectre-icons.min.css') + link(rel='stylesheet' href='dist/spectre-exp.min.css') + link(rel='stylesheet' href='dist/docs.min.css') + link(rel='canonical' href= url) + + body + block content + + script. + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-2702768-8', 'auto'); + ga('send', 'pageview'); + + \ No newline at end of file diff --git a/docs/src/_layout/_mixins.pug b/docs/src/_layout/_mixins.pug new file mode 100644 index 0000000..4d75f85 --- /dev/null +++ b/docs/src/_layout/_mixins.pug @@ -0,0 +1,25 @@ +mixin docs-accordion(id, name, ...pages) + .accordion + input(id='accordion-' + id type='checkbox' name='docs-accordion-checkbox' hidden='' checked=(parent === id ? true : false)) + label.accordion-header.c-hand(for='accordion-' + id)= name + .accordion-body + ul.menu.menu-nav + each page in pages + li.menu-item + if slug != parent + a(href='../' + id + '/' + page.url + '.html')= page.name + else + a(href=id + '/' + page.url + '.html')= page.name + +mixin docs-heading(id, name) + .container(id=id) + h3.s-title + | #{name} + a.anchor(href='#'+id aria-hidden='true') # + if block + block + +mixin docs-subheading(id, name) + h4.s-subtitle(id=id) + | #{name} + a.anchor(href='#'+id aria-hidden='true') # \ No newline at end of file -- cgit v1.3.1-23-gd82d