Improve titles and headers for smart contract docs section (#547)

In reference to #545
5 years ago · 31aac0a531
10 changed files with 97 additions and 16 deletions
--- a/_core/smart/clarityCLI.md
+++ b/_core/smart/clarityCLI.md
@ -1,9 +1,9 @@
 ---
 layout: smart
-description: "Blockstack smart contracting language"
+description: "Clarity CLI: Reference"
 permalink: /:collection/:path.html
 ---
-# clarity-cli VM command line
+# Clarity CLI
 {:.no_toc}

 You use the `clarity-cli` command to work with smart contracts within the Blockstack virtual environment. This command has the following subcommands:
--- a/_core/smart/clarityRef.md
+++ b/_core/smart/clarityRef.md
@ -1,9 +1,9 @@
 ---
 layout: smart
-description: "Blockstack smart contracting language"
+description: "Clarity: Language Reference"
 permalink: /:collection/:path.html
 ---
-# Language Reference
+# Clarity

 This file contains the reference for the Clarity language. 

--- a/_core/smart/functions.md
+++ b/_core/smart/functions.md
@ -1,6 +1,6 @@
 ---
 layout: smart
-description: "Blockstack smart contracting language"
+description: "Clarity: Defining Functions and Maps"
 permalink: /:collection/:path.html
 ---
 # Defining Functions and Maps
--- a/_core/smart/principals.md
+++ b/_core/smart/principals.md
@ -1,10 +1,6 @@
 ---
-<<<<<<< HEAD
 layout: smart
-description: "Blockstack smart contracting language"
-=======
-layout: core
->>>>>>> Updates from stacks-blockchain:master (#543)
+description: "Clarity: Understanding Principals"
 permalink: /:collection/:path.html
 ---
 # Principals
--- a/_core/smart/sdk-quickstart.md
+++ b/_core/smart/sdk-quickstart.md
@ -1,9 +1,9 @@
 ---
 layout: smart
-description: "Blockstack smart contracting language"
+description: "Clarity SDK: Quickstart"
 permalink: /:collection/:path.html
 ---
-# Clarity SDK Quickstart
+# Clarity SDK
 {:.no_toc}

 You can use the software developer kit (SDK) to develop, test, and deploy Clarity smart contracts. The SDK goes beyond the basic test environment to allow for development of Javascript or TypeScript clients that call upon Clarity contracts.
--- a/_core/smart/tutorial-counter.md
+++ b/_core/smart/tutorial-counter.md
@ -1,6 +1,6 @@
 ---
 layout: smart
-description: "Blockstack Clarity: Counter Tutorial"
+description: "Clarity: Counter Tutorial"
 permalink: /:collection/:path.html
 ---
 # Counter
--- a/_core/smart/tutorial.md
+++ b/_core/smart/tutorial.md
@ -1,6 +1,6 @@
 ---
 layout: smart
-description: "Blockstack Clarity: Hello World Tutorial"
+description: "Clarity: Hello World Tutorial"
 permalink: /:collection/:path.html
 ---
 # Hello World
--- a/_includes/head-desc.html
+++ b/_includes/head-desc.html
@ -0,0 +1,50 @@
+<head>
+  {% gtm head %}
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ page.description | escape }}</title>
+  {% seo title=false %}
+  {% seo description=false %}
+  <!-- <meta property="og:image" content="{% if site.brand.image contains 'http' %}{{ site.brand.image }}{% else %}{{ site.post_assets | url }}{{ site.brand.image }}{% endif %}"/> -->
+  <meta property="og:image" content="{{site.url}}{{ page.image }}"/>
+  <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}">
+  <link rel="shortcut icon" type="image/png" href="{{ "assets/img/touch-icon.png" | relative_url }}" >
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | relative_url }}">
+  <script src="{{ "/assets/js/main.js" | relative_url }}" ></script>
+  {% if jekyll.environment == 'production' and site.google_analytics %}
+    {% include google-analytics.html %}
+  {% endif %}
+  <!-- https://www.bryanbraun.com/anchorjs/  -->
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
+  <script type"text/javascript" src="https://code.jquery.com/jquery-latest.min.js">
+    switcherTab('uk-tab-instance');
+
+    function switcherTab(id){
+        $('#'+id+' a[href = "'+window.location.hash+'"]').parent('li').click();
+
+        $('#'+id+' a').click(function(){
+            var val = $(this).attr('href');
+            window.location.hash = val.replace("#", "");
+        });
+    }
+  </script>
+  	<!-- Load jquery.cookie plugin (optional) -->
+	<script type="text/javascript" src="/assets/navgoco/jquery.cookie.js"></script>
+	<!-- Load jquery.navgoco plugin js and css files -->
+	<script type="text/javascript" src="/assets/navgoco/jquery.navgoco.js"></script>
+  <link rel="stylesheet" href="/assets/navgoco/jquery.navgoco.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+    $(document).ready(function() {
+      $('.nav').navgoco({
+          caretHtml: '<i class="some-random-icon-class"></i>',
+          accordion: true,
+          openClass: 'open',
+          slide: {
+            duration: 400,
+            easing: 'swing'
+          }
+        });
+    });
+  </script>
+</head>
--- a/_layouts/default-desc.html
+++ b/_layouts/default-desc.html
@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+
+    {% include head-desc.html %}
+
+    <body>
+    {% gtm body %}
+
+    {% include header.html %}
+
+    {% if page.hero %}
+        {% include hero.html %}
+    {% endif %}
+
+    {{ content }}
+
+    {% include offcanvas.html %}
+
+    {% if page.hero %}
+        {% include search-hero.html %}
+    {% else %}
+        {% include search.html %}
+    {% endif %}
+
+
+    <script>
+    anchors.options = {
+      placement: 'left',
+      visible: 'hover'
+    };
+       anchors.add();
+     </script>
+    </body>
+
+</html>
--- a/_layouts/smart.html
+++ b/_layouts/smart.html
@ -1,5 +1,5 @@
 ---
-layout: default
+layout: default-desc
 ---

 <div class="uk-section">
@ -39,7 +39,7 @@ layout: default

                <article markdown="span" class="uk-article">

-                    <h1 class="uk-article-title">{{ page.title | escape }}</h1>
+                    <h1 class="uk-article-title">{{ page.description | escape }}</h1>

                    {% if page.subtitle %}<p class="subtitle uk-text-lead uk-text-muted">{{ page.subtitle }}</p>
                    {% endif %}