Merge https://github.com/gcushen/hugo-academic into master

README.md

@@ -4,22 +4,20 @@
 
 ### The Page Builder to Easily Create Professional Websites :pencil2: :newspaper: :rocket:
 
-**Create a free website with Academic using Markdown, Jupyter, or RStudio. Choose a beautiful color theme and build anything with the Page Builder - over 50 _widgets_, _themes_, and _language packs_ included!**
+**Create _any_ kind of website for free with Academic using Markdown, Jupyter, or RStudio. Choose a beautiful color theme and build anything with the Page Builder - over 50 _widgets_, _themes_, and _language packs_ included!**
 
-[Check out the latest **demo**](https://academic-demo.netlify.app) of what you'll get in less than 10 minutes, or [view the **showcase**](https://sourcethemes.com/academic/#expo) of personal, project, and business sites.
+[Check out the latest **demo**](https://academic-demo.netlify.app) of what you'll get in less than 10 minutes, or [view the **showcase**](https://sourcethemes.com/academic/user-stories/) of personal, project, and business sites.
 
 - 👉 [**Get Started**](https://sourcethemes.com/academic/docs/install/)
 - 📚 [View the **documentation**](https://sourcethemes.com/academic/docs/)
 - 💬 [Chat with the **Academic community**](https://spectrum.chat/academic) or [**Hugo community**](https://discourse.gohugo.io)
-- 🐦 Twitter: [@source_themes](https://twitter.com/source_themes) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithAcademic](https://twitter.com/search?q=%23MadeWithAcademic&src=typd)
-- 💡 [Request a **feature** or report a **bug**](https://github.com/gcushen/hugo-academic/issues)
-- ⬆️ **Updating?** View the [Update Guide](https://sourcethemes.com/academic/docs/update/) and [Release Notes](https://sourcethemes.com/academic/updates/)
 - :heart: **Support development** of Academic:
+  - :heart: [**Become a backer** on GitHub or Patreon to **unlock rewards and extra features**](https://sourcethemes.com/academic/plans/)
   - ☕️ [**Donate a coffee**](https://paypal.me/cushen)
-  - 💵 [Become a backer on **Patreon** and **unlock rewards**](https://www.patreon.com/cushen)
-  - 🖼️ [Decorate your laptop or journal with an Academic **sticker**](https://www.redbubble.com/people/neutreno/works/34387919-academic)
-  - 👕 [Wear the **T-shirt**](https://academic.threadless.com/)
   - :woman_technologist: [**Contribute**](https://sourcethemes.com/academic/docs/contribute/)
+- 🐦 Twitter: [@source_themes](https://twitter.com/source_themes) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithAcademic](https://twitter.com/search?q=%23MadeWithAcademic&src=typd)
+- 💡 [Request a **feature** or report a **bug**](https://github.com/gcushen/hugo-academic/issues)
+- ⬆️ **Updating?** View the [Update Guide](https://sourcethemes.com/academic/docs/update/) and [Release Notes](https://sourcethemes.com/academic/updates/)
 
 [![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/academic.png)](https://github.com/gcushen/hugo-academic/)
 
@@ -60,43 +58,25 @@ Choose a stunning theme for your site and [customize it](https://sourcethemes.co
 * **[Academic Admin](https://github.com/sourcethemes/academic-admin):** An admin tool to import publications from BibTeX or import assets for an offline site
 * **[Academic Scripts](https://github.com/sourcethemes/academic-scripts):** Scripts to help migrate content to new versions of Academic
 
-## Install
+## Create your site
 
 You can choose from one of the following four methods to install:
 
-* **one-click install using your web browser (recommended)**
+* **one-minute Github/Gitlab install using your web browser (recommended)**
 * install on your computer using Git with the Command Prompt/Terminal app
 * install on your computer by downloading the ZIP files
 * install on your computer with RStudio
 
-### Install with web browser
-
-[**Create your site now with Netlify** :rocket:](https://app.netlify.com/start/deploy?repository=https://github.com/sourcethemes/academic-kickstart)
-
-* One-click install of Academic creates an `academic-kickstart` repository in your GitHub or GitLab account
-* Netlify will provide you with a customizable URL to access your new site, [or get your own domain](https://sourcethemes.com/academic/docs/domain/)
-* Around 1-5 minutes after editing content in your repository, your site will automatically update
-  - If your site fails to update, [login to Netlify](https://www.netlify.com/), click your site, go to **Deploys**, and review the latest deploy log for any errors
-* To **easily edit your site in a rich online editor in your browser**,
-  - [Login to Netlify](https://www.netlify.com/) and click the site you deployed with Netlify
-  - Go to **Settings > Identity**, and select **Enable Identity** service
-  - Under **Registration** preferences, select **Invite Only**
-  - Scroll down to **Services > Git Gateway**, and click **Enable Git Gateway**
-  - Head over to **`YOUR_SITE.com/admin/`** to view your content management panel and begin publishing content
-  - For support with _Netlify CMS_ admin panel, refer to the [Netlify CMS docs](https://www.netlifycms.org/docs/add-to-your-site/#authentication) and the very active [Netlify CMS community](https://www.netlifycms.org/community/)
-* To edit your site in a [Markdown editor](https://www.typora.io) on your computer,
-  - Perform the steps in the [*Install with Git*](#install-with-git) section below
+### Create your site with GitHub
 
-Once you have followed the link above to automatically install Academic, head on over to your new `academic-kickstart` repository in your GitHub (or GitLab) account and [personalize your site by editing the files in](https://sourcethemes.com/academic/docs/get-started/) `config/_default/`. Shortly after saving (i.e. *committing* a file), your site will automatically update.
-   
-View the [Homepage Builder](https://sourcethemes.com/academic/docs/page-builder/) and [Content](https://sourcethemes.com/academic/docs/managing-content/) guides to learn how to add widgets and content. For inspiration, refer to the [Markdown content](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) which powers the [Demo](https://academic-demo.netlify.app).
+[**Create your site now with GitHub** :rocket:](https://sourcethemes.com/academic/docs/install/)
 
-### Install with Git
+### Create your site on your computer with Git
 
 Prerequisites:
 
 * [Download and install Git](https://git-scm.com/downloads)
-* [Download and install Hugo Extended v0.65-v0.72](https://gohugo.io/getting-started/installing/#quick-install)
+* [Download and install Hugo Extended v0.73-v0.74](https://gohugo.io/getting-started/installing/#quick-install)
 
 Install:
 
@@ -115,20 +95,20 @@ Install:
     git submodule update --init --recursive
     ```
 
-### Install with ZIP
+### Create your site on your computer _without_ Git
 
 Prerequisites:
 
-* [Download and install Hugo Extended v0.65-v0.72](https://gohugo.io/getting-started/installing/#quick-install)
+* [Download and install Hugo Extended v0.73-v0.74](https://gohugo.io/getting-started/installing/#quick-install)
 
 Install:
 
 1. [Download](https://github.com/sourcethemes/academic-kickstart/archive/master.zip) and extract *Academic Kickstart*
 2. [Download](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract the *Academic theme* files from the `hugo-academic-master` folder to the `themes/academic/` folder in *Academic Kickstart*
 
-### Install with RStudio
+### Create your site with RStudio
 
-[Install Academic with RStudio](https://sourcethemes.com/academic/docs/install/#install-with-rstudio)
+[Install Academic with RStudio](http://localhost:59000/academic/docs/install-locally/#install-with-rstudio)
 
 ## Demo content
 

archetypes/home.md

@@ -27,7 +27,7 @@ subtitle = ""
   # gradient_end = "SkyBlue"
   
   # Background image.
-  # image = "image.jpg"  # Name of image in `static/img/`.
+  # image = "image.jpg"  # Name of image in `static/media/`.
   # image_darken = 0.6  # Darken the image? Range 0-1 where 0 is transparent and 1 is opaque.
 
   # Text color (true=light or false=dark).

assets/js/academic.js

@@ -72,7 +72,7 @@
    * Add smooth scrolling to all links inside the main navbar.
    * --------------------------------------------------------------------------- */
 
-  $('#navbar-main li.nav-item a.nav-link').on('click', function (event) {
+  $('#navbar-main li.nav-item a.nav-link, .js-scroll').on('click', function (event) {
     // Store requested URL hash.
     let hash = this.hash;
 

assets/scss/vendor/bootstrap/_mixins.scss → assets/scss/_vendor/bootstrap/_mixins.scss

@@ -3,7 +3,7 @@
 // Used in conjunction with global variables to enable certain theme features.
 
 // Vendor
-@import "vendor/rfs";
+@import "_vendor/rfs";
 
 // Deprecate
 @import "mixins/deprecate";

assets/scss/academic/_content.scss

@@ -132,6 +132,29 @@ article .article-metadata {
   content: '\00B7';
 }
 
+@mixin word-wrap() {
+  // Break very long words such as pasted URL strings.
+  overflow-wrap: break-word;
+  word-wrap: break-word;
+  -ms-word-break: break-all;
+  word-break: break-all;
+  word-break: break-word;
+
+  // Add a hyphen where the word breaks, if supported (No Blink).
+  -ms-hyphens: auto;
+  -moz-hyphens: auto;
+  -webkit-hyphens: auto;
+  hyphens: auto;
+}
+
+.article-style {
+  // Break unresponsive block content, such as unresponsive embeds, to prevent horizontal scrolling.
+  overflow-x: hidden;
+
+  // Word wrap text content.
+  @include word-wrap();
+}
+
 .article-style img,
 .article-style video {
   margin-left: auto;

assets/scss/academic/_docs.scss

@@ -108,6 +108,7 @@
 }
 
 .docs-sidebar .docs-toc-item.active a,
+.docs-sidebar .docs-toc-item a.active, // Book layout sidebar links
 .docs-sidebar .nav>.active:hover>a,
 .docs-sidebar .nav>.active>a {
   font-weight: bold;

assets/scss/academic/_nav.scss

@@ -69,7 +69,28 @@
 }
 
 .dark .navbar {
+  background: $sta-dark-menu-primary;
   box-shadow: 0 0.125rem 0.25rem 0 rgba(255, 255, 255, .11);
+  .navbar-nav {
+    .nav-link {
+      color: rgba($sta-dark-menu-text, .85);
+
+      &.active,
+      &:hover,
+      &:focus {
+        color: $sta-dark-menu-text;
+      }
+
+      &.active {
+        font-weight: bold !important;
+        color: $sta-dark-menu-text-active !important;
+      }
+    }
+  }
+  .dropdown-item.active,
+  .dropdown-item-active {
+    color: $sta-dark-menu-text-active !important;
+  }
 }
 
 // Remove Bootstrap's border from Toggle button.
@@ -136,6 +157,10 @@
   color: $sta-menu-text;
 }
 
+.dark #navbar-main .main-menu-item ul li .nav-link {
+  color: $sta-dark-menu-text;
+}
+
 @include media-breakpoint-down(md) {
   // Used in conjunction with mobile .navbar-brand to center logo on mobile.
   .navbar-brand-mobile-wrapper {
@@ -166,6 +191,9 @@
     background-color: $sta-menu-primary;
     text-align: center !important;
   }
+  .dark .navbar-collapse {
+    background-color: $sta-dark-menu-primary;
+  }
   #navbar-main .main-menu-item .nav-item {
     padding: 10px 15px !important;
   }
@@ -200,7 +228,17 @@ ul.nav-icons li.nav-item a.nav-link {
   z-index: 1032;  // I18n dropdown over mobile expanded menu.
 }
 
+.dark .dropdown-menu {
+  background-color: $sta-dark-menu-primary !important;
+  color: $sta-dark-menu-text !important;
+}
+
 .dropdown-item {
   background-color: $sta-menu-primary !important;
   color: $sta-menu-text !important;
 }
+
+.dark .dropdown-item {
+  background-color: $sta-dark-menu-primary !important;
+  color: $sta-dark-menu-text !important;
+}

assets/scss/academic/_root.scss

@@ -29,6 +29,9 @@ body {
     margin-top: 50px; /* Offset body content by navbar height. */
   }
 }
+body.no-navbar {
+  margin-top: 0 !important;
+}
 
 .max-width-640 {
   max-width: 640px;
@@ -121,6 +124,16 @@ a:focus {
   color: $sta-link-hover;
 }
 
+.dark a,
+.dark h3.article-title a:hover {
+  color: $sta-dark-link;
+}
+
+.dark a:hover,
+.dark a:focus {
+  color: $sta-dark-link-hover;
+}
+
 img,
 video {
   height: auto;
@@ -128,6 +141,11 @@ video {
   display: block;
 }
 
+audio {
+  width: 100%;
+  margin-bottom: 20px
+}
+
 video {
   width: 100%;
   height: auto;
@@ -424,7 +442,7 @@ a.badge:hover {
 .btn {
   padding: .5rem;
   font-size: .8rem;
-  line-height: .5;
+  line-height: .9;  // Anything less and multiline button text may overlap.
   border-radius: .3rem;
 }
 

assets/scss/academic/_widgets.scss

@@ -12,6 +12,7 @@
 }
 
 .home-section {
+  position: relative;  // Required for component positioning within section.
   background-color: $sta-home-section-odd;
   padding: 110px 0 110px 0;
   animation: intro 0.3s both;

assets/scss/main.scss

@@ -21,11 +21,19 @@ $sta-primary-dark: darken($sta-primary, $sta-darken-percentage);
 $sta-link: {{ $scr.Get "link" }};
 $sta-link-hover: {{ $scr.Get "link_hover" }};
 
+$sta-dark-link: {{ $scr.Get "dark_link" }};
+$sta-dark-link-hover: {{ $scr.Get "dark_link_hover" }};
+
 $sta-menu-primary: {{ $scr.Get "menu_primary" }};
 $sta-menu-text: {{ $scr.Get "menu_text" }};
 $sta-menu-text-active: {{ $scr.Get "menu_text_active" }};
 $sta-menu-title: {{ $scr.Get "menu_title" }};
 
+$sta-dark-menu-primary: {{ $scr.Get "dark_menu_primary" }};
+$sta-dark-menu-text: {{ $scr.Get "dark_menu_text" }};
+$sta-dark-menu-text-active: {{ $scr.Get "dark_menu_text_active" }};
+$sta-dark-menu-title: {{ $scr.Get "dark_menu_title" }};
+
 $sta-background: {{ $scr.Get "background" }};
 $sta-dark-background: {{ $scr.Get "dark_background" }};
 
@@ -36,6 +44,7 @@ $sta-dark-home-section-odd: {{ $scr.Get "dark_home_section_odd" }};
 $sta-dark-home-section-even: {{ $scr.Get "dark_home_section_even" }};
 
 @import "bootstrap_variables";
-@import "vendor/bootstrap/bootstrap";
+@import "_vendor/bootstrap/bootstrap";
 @import "academic/academic";
+@import "template";
 @import "custom";

assets/scss/template.scss

@@ -0,0 +1 @@
+// Templates override this file with their own SCSS styling.