diff --git a/themes/ace-documentation b/themes/ace-documentation deleted file mode 160000 index 10892bc..0000000 --- a/themes/ace-documentation +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 10892bc2a6f35affa2159c4ccea7117cce20810a diff --git a/themes/ace-documentation/CHANGELOG.md b/themes/ace-documentation/CHANGELOG.md new file mode 100644 index 0000000..17eb2be --- /dev/null +++ b/themes/ace-documentation/CHANGELOG.md @@ -0,0 +1,26 @@ +## Version 1.0.4 + - Updated Bootstrap to v4.5 + +## Version 1.0.3 + - [FIX] Typo in readme, added changelog, updated config.toml in exampleSite + - [FIX] Remove source map imports from JS files ([@jhollowe, PR #8](https://github.com/vantagedesign/ace-documentation/pull/8)) + - [FIX] Fix minifier error with spacing in next-prev-page ([@jhollowe, PR #6](https://github.com/vantagedesign/ace-documentation/pull/6)) + - [ADD] Allow disabling the TOC ([@jhollowe, PR #9](https://github.com/vantagedesign/ace-documentation/pull/9)) + - [ADD] Allow Google Analytics to only track production site ([@jhollowe, PR #7](https://github.com/vantagedesign/ace-documentation/pull/7)) + - [FIX] Prevent empty heaver toggler ([@jhollowe, PR #3](https://github.com/vantagedesign/ace-documentation/pull/3)) + - [ADD] New table shortcode for styled tables (fixes [issue #2](https://github.com/vantagedesign/ace-documentation/issues/2)) + - [ADD] Allow disabling the Read more navigation per page or for the entire site using the config (implements [issue #10](https://github.com/vantagedesign/ace-documentation/issues/10)) + - [ADD] Documentation for various config options, such as disabling toc, readmore, analytics and search. + + +## Version 1.0.2 + +- [FIX] Fixed folder structure in exampleSite for non-extended Hugo version. + +## Version 1.0.1 + +- [FIX] Include the resources folder in the theme for Hugo standard version. + +## Version 1.0.0 + + - Initial release \ No newline at end of file diff --git a/themes/ace-documentation/LICENSE.md b/themes/ace-documentation/LICENSE.md new file mode 100644 index 0000000..a8a28e8 --- /dev/null +++ b/themes/ace-documentation/LICENSE.md @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2020 Vantage Design + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/themes/ace-documentation/README.md b/themes/ace-documentation/README.md new file mode 100644 index 0000000..ac91aab --- /dev/null +++ b/themes/ace-documentation/README.md @@ -0,0 +1,84 @@ +# [Ace documentation](https://docs.vantage-design.com/ace) + +![Product thumbnail](https://raw.githubusercontent.com/vantagedesign/assets/master/ace-documentation/ace-thumbnail-shadow.png) + +Create beautiful documentation for your projects with Ace for Hugo. Powered by Bootstrap and SASS, featuring must-have features such as syntax highlighting, copy-able code blocks, full search, a responsive layout and the power of Markdown to create your content. + +Writing documentation has never been so easy. + +### Rich in features +Ace offers a variety of custom components and features which are a must-have for building project documentation. Code blocks are enriched with syntax highlighting and a copy button, allowing for your users to easily read your code and copy it into their project. Furthermore, a special version of the code block renders the HTML content in both the code block and on the page, giving your users a preview of what the code looks like. + +Other shortcodes allow you to use Bootstrap components in your content, such as alerts, buttons, panels, collapse elements and more. + +Full search allows your users to quickly find the content they require, and a responsive design makes your documentation available on both desktop and mobile devices. + +### Beautiful minimalist design +With a minimal design, the attention of users is focused on that which matters: your content. + + + +## Demo & documentation +The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo. + + - [Ace demo & documentation](https://docs.vantage-design.com/ace) + + + +## Installation + +- [Download from GitHub](https://github.com/vantagedesign/ace-documentation/releases) +- Clone the repo `git clone https://github.com/vantagedesign/ace-documentation.git` + +*Note:* this theme only works with Hugo's extended version, due to the SCSS compile functionality. + + + +## Resources + +- [Store page](https://vantage-design.com/products/documentation-themes/4/ace-documentation) +- [Demo](https://docs.vantage-design.com/ace) +- [Documentation](https://docs.vantage-design.com/ace) +- [Issues](https://github.com/vantagedesign/ace-documentation/issues) +- [License](https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE.md) + + + +## Reporting Issues + +We use GitHub Issues as the official bug tracker for the Ace documentation. When reporting an issue, please follow the following guidelines: + +1. Make sure that you are using the latest version of Ace documentation. +2. Provide us with reproducible steps for recreating the issue, in order for us to find the issue and fix is as soon as possible. +3. Specify your browser and version of Ace. + + + +## Contributing to Ace + +Contributions are highly appreciated and may be done by reporting issues with new feature suggestions or bug fixes, or by making pull requests. We'll try our best to get those sorted as soon as possible. + +Please make pull requests to the [dev branch](https://github.com/vantagedesign/ace-documentation/tree/dev). Make sure you're always running the latest version of Ace and that you are not committing breaking changes. + + + +## Licensing + +- Copyright 2020 [Vantage Design](https://vantage-design.com) +- Licensed under MIT (https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE.md) + + + +## Useful links + +- [More products](https://vantage-design.com) +- [Free products](https://vantage-design.com/products/free-products/) +- [Premium products](https://vantage-design.com/products/premium-products/) +- [Design systems](https://vantage-design.com/products/design-systems/) +- [Page templates](https://vantage-design.com/products/page-templates/) +- [Documentation themes](https://vantage-design.com/products/documentation-themes/) + +### Social Media + +- Facebook: +- Instagram: diff --git a/themes/ace-documentation/archetypes/default.md b/themes/ace-documentation/archetypes/default.md new file mode 100644 index 0000000..ac36e06 --- /dev/null +++ b/themes/ace-documentation/archetypes/default.md @@ -0,0 +1,2 @@ ++++ ++++ diff --git a/themes/ace-documentation/assets/css/ace.scss b/themes/ace-documentation/assets/css/ace.scss new file mode 100644 index 0000000..731585d --- /dev/null +++ b/themes/ace-documentation/assets/css/ace.scss @@ -0,0 +1,128 @@ +/* ------------------------------------------------------------------------- +* ACE DOCUMENTATION +* Stylesheet +* @author Vantage Design +* @version 1.0.4 +* @license https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE +* ------------------------------------------------------------------------ */ + +$primary: #1565c0; +$secondary: #e28112; +$success: #28a745; +$info: #0DA0D6; +$warning: #ffc107; +$danger: #dc3545; +$light: #f8f9fa; +$dark: #343a40; + +@import "bootstrap/bootstrap"; + +/* Typography styling */ +.main > h1{ + padding-top: 2rem; +} + +.main > h2{ + padding-top: 4rem; + margin-top:-1rem; +} + +.main > h3, .main > h4, .main > h5, .main > h6{ + padding-top: 4rem; + margin-top:-3rem; +} + +.haschildren ul{ + color: gray; + display:none; +} + +.haschildren.active ul, .haschildren.parent ul{ + display:block; +} + +.highlight > pre { + padding:15px; +} + +.navbar-brand img { + height: 3rem; +} + +.feed-icons img { + height: 1.5rem; +} + +/* Side navigation menus */ +.docs-sidenav span.badge.badge-primary, .docs-toc span.badge.badge-primary{ + font-size: 10px; +} + +@media (min-width: 768px) { + .docs-sidenav, .docs-toc{ + height: calc(100vh - 4rem); + top:4rem; + position: sticky; + overflow: auto; + } + .docs-sidenav .navbar, .docs-toc .navbar{ + padding-right: 0; + } + .docs-sidenav .navbar-collapse, .docs-sidenav .navbar-nav{ + width: 100%; + } + .docs-sidenav .nav-link, .docs-toc li a{ + display: flex; + align-items: start; + justify-content: space-between; + } + .docs-sidenav .nav-link > span.badge.badge-primary, .docs-toc li a > span.badge.badge-primary{ + margin-top: 5px; + } +} + +@media (min-width: 1200px) { + .docs-toc.large{ + height: calc(100vh - 4rem); + } +} + +@media (max-width: 1200px) { + .docs-toc.large{ + display:none; + } +} + +.docs-toc{ + padding-top: 10px; +} + +.docs-toc a{ + font-size: 14px; + color: gray; +} + +.docs-toc a:hover{ + color: #333; +} + +.docs-toc ul{ + list-style: none; + padding-left:8px; + margin-top:3px; +} + +.docs-toc ul:first-child{ + padding-left:0; +} + +/* Table tweak for JavaScript methods */ +table td:first-child > code{ + word-break: normal; +} + +table > tbody > tr > td, .bd-content > table > tbody > tr > th, .bd-content > table > tfoot > tr > td, .bd-content > table > tfoot > tr > th, .bd-content > table > thead > tr > td, .bd-content > table > thead > tr > th { + padding: .75rem; + vertical-align: top; + border: 1px solid #dee2e6; +} diff --git a/themes/ace-documentation/assets/css/bootstrap/_alert.scss b/themes/ace-documentation/assets/css/bootstrap/_alert.scss new file mode 100644 index 0000000..da2a98a --- /dev/null +++ b/themes/ace-documentation/assets/css/bootstrap/_alert.scss @@ -0,0 +1,51 @@ +// +// Base styles +// + +.alert { + position: relative; + padding: $alert-padding-y $alert-padding-x; + margin-bottom: $alert-margin-bottom; + border: $alert-border-width solid transparent; + @include border-radius($alert-border-radius); +} + +// Headings for larger alerts +.alert-heading { + // Specified to prevent conflicts of changing $headings-color + color: inherit; +} + +// Provide class for links that match alerts +.alert-link { + font-weight: $alert-link-font-weight; +} + + +// Dismissible alerts +// +// Expand the right padding and account for the close button's positioning. + +.alert-dismissible { + padding-right: $close-font-size + $alert-padding-x * 2; + + // Adjust close link position + .close { + position: absolute; + top: 0; + right: 0; + padding: $alert-padding-y $alert-padding-x; + color: inherit; + } +} + + +// Alternate styles +// +// Generate contextual modifier classes for colorizing the alert. + +@each $color, $value in $theme-colors { + .alert-#{$color} { + @include alert-variant(theme-color-level($color, $alert-bg-level), theme-color-level($color, $alert-border-level), theme-color-level($color, $alert-color-level)); + } +} diff --git a/themes/ace-documentation/assets/css/bootstrap/_badge.scss b/themes/ace-documentation/assets/css/bootstrap/_badge.scss new file mode 100644 index 0000000..42c5d08 --- /dev/null +++ b/themes/ace-documentation/assets/css/bootstrap/_badge.scss @@ -0,0 +1,54 @@ +// Base class +// +// Requires one of the contextual, color modifier classes for `color` and +// `background-color`. + +.badge { + display: inline-block; + padding: $badge-padding-y $badge-padding-x; + @include font-size($badge-font-size); + font-weight: $badge-font-weight; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + @include border-radius($badge-border-radius); + @include transition($badge-transition); + + @at-root a#{&} { + @include hover-focus() { + text-decoration: none; + } + } + + // Empty badges collapse automatically + &:empty { + display: none; + } +} + +// Quick fix for badges in buttons +.btn .badge { + position: relative; + top: -1px; +} + +// Pill badges +// +// Make them extra rounded with a modifier to replace v3's badges. + +.badge-pill { + padding-right: $badge-pill-padding-x; + padding-left: $badge-pill-padding-x; + @include border-radius($badge-pill-border-radius); +} + +// Colors +// +// Contextual variations (linked badges get darker on :hover). + +@each $color, $value in $theme-colors { + .badge-#{$color} { + @include badge-variant($value); + } +} diff --git a/themes/ace-documentation/assets/css/bootstrap/_breadcrumb.scss b/themes/ace-documentation/assets/css/bootstrap/_breadcrumb.scss new file mode 100644 index 0000000..a0cf7e2 --- /dev/null +++ b/themes/ace-documentation/assets/css/bootstrap/_breadcrumb.scss @@ -0,0 +1,44 @@ +.breadcrumb { + display: flex; + flex-wrap: wrap; + padding: $breadcrumb-padding-y $breadcrumb-padding-x; + margin-bottom: $breadcrumb-margin-bottom; + @include font-size($breadcrumb-font-size); + list-style: none; + background-color: $breadcrumb-bg; + @include border-radius($breadcrumb-border-radius); +} + +.breadcrumb-item { + display: flex; + + // The separator between breadcrumbs (by default, a forward-slash: "/") + + .breadcrumb-item { + padding-left: $breadcrumb-item-padding; + + &::before { + display: inline-block; // Suppress underlining of the separator in modern browsers + padding-right: $breadcrumb-item-padding; + color: $breadcrumb-divider-color; + content: escape-svg($breadcrumb-divider); + } + } + + // IE9-11 hack to properly handle hyperlink underlines for breadcrumbs built + // without `