jekyll-theme-alta-docs 0.2.0 → 0.3.0

data/_includes/nav.html

@@ -7,6 +7,15 @@
     {% assign current = null %}
 {% endif %}
 
+{% assign current_category = null %}
+{% for cat in docs_grouped %}
+  {% for doc in cat.items %}
+    {% if doc.url == page.url %}
+      {% assign current_category = doc.category %}
+    {% endif %}
+  {% endfor %}
+{% endfor %}
+
 <nav class="ad-site-nav">
 
   <a href="/" class="ad-btn-nav-home {{ current }}">
@@ -14,7 +23,11 @@
   </a>
 
   {% for cat in docs_grouped %}
-    <button class="ad-collapsible">{{ cat.name }}</button>
+    {% if current_category == cat.name %}
+      <button class="ad-collapsible active">{{ cat.name }}</button>
+    {% else %}
+      <button class="ad-collapsible">{{ cat.name }}</button>
+    {% endif %}
     <ul class="ad-collapsible-content">
     {% for doc in cat.items %}
       {% if doc.url == page.url %}
@@ -42,5 +55,15 @@ for (i = 0; i < coll.length; i++) {
       content.style.maxHeight = content.scrollHeight + "px";
     }
   });
+
+  // Expand already active category:
+  if (coll[i].classList.contains('active')) {
+    var content = coll[i].nextElementSibling;
+    if (content.style.maxHeight){
+      content.style.maxHeight = null;
+    } else {
+      content.style.maxHeight = content.scrollHeight + "px";
+    }
+  }
 }
 </script>

data/_includes/templates/rails/rails_readme.md

@@ -0,0 +1,52 @@
+{% assign project_name = 'project-name' %}
+{% if include.project_name %}
+  {% assign project_name = include.project_name %}
+{% endif %}
+
+## {{ project_name | capitalize }}
+
+The API for {{ project_name }} built with Ruby on Rails.
+
+
+### Getting started
+
+**Prerequisites:** Ruby, Rails and PostgreSQL are already installed on the machine.
+
+1. Download project (i.e. git clone)
+
+2. Set up environment variables with `dotenv`:
+  2.1 Copy-paste `.env.template` and rename to `.env`.
+  2.2 Open `.env` and set environment variables.
+
+2. Install gems:
+
+      $ bundle install
+
+3. Set up database:
+
+      $ rake db:create
+      $ rake db:migrate
+      $ rake db:seed
+
+4. Run project
+
+      $ rails s
+      # OR
+      $ rails s -b xxx.xx.xxx.xx -p 4001
+
+
+### Documentation
+
+You can find more details about the project in docs repository: **{{ project_name}}-docs**
+
+### Development
+
+Follow instructions from [Getting started](#getting-started) to run project.
+
+### Tests
+
+TODO
+
+### Deployment
+
+TODO

data/_includes/templates/react/react_readme.md

@@ -0,0 +1,54 @@
+{% assign project_name = 'project-name' %}
+{% if include.project_name %}
+  {% assign project_name = include.project_name %}
+{% endif %}
+
+## {{ project_name | capitalize }}
+
+The web application for {{ project_name }} built with React.JS.
+
+
+### Getting started
+
+**Prerequisites:** Node.js and npm/yarn/npx already installed.
+
+1. Download project (i.e. git clone)
+
+2. Adjust environment variables in `src/config/*` files.
+
+3. Install:
+
+      $ yarn install
+
+4. Start project
+
+      $ yarn start
+
+
+### Documentation
+
+You can find more details about the project in docs repository: **{{ project_name}}-docs**
+
+### Development
+
+Follow instructions from [Getting started](#getting-started) to run project.
+
+### Scripts
+
+`yarn start` - start application
+
+`yarn test` - test application
+
+`yarn build` - build application
+
+`yarn lint` - run eslint
+
+`yarn format` - format code with Prettier
+
+### Tests
+
+TODO
+
+### Deployment
+
+TODO

data/_sass/jekyll-theme-alta-docs.scss

@@ -103,6 +103,10 @@ a.ad-btn-nav-home {
 }
 
 h1 {
+  font-family: $font-family-primary;
+  font-size: 42px;
+  text-transform: uppercase;
+  font-weight: 800;
   i.fas, .symbol {
     font-size: 20px;
     margin-right: 7px;
@@ -110,6 +114,11 @@ h1 {
 }
 
 h2 {
+  margin-top: 60px;
+  margin-bottom: 15px;
+  font-size: 32px;
+  font-family: $font-family-primary;
+  border-bottom: 1px solid $gray-400;
   i.fas, .symbol {
     font-size: 16px;
     margin-right: 5px;
@@ -117,12 +126,37 @@ h2 {
 }
 
 h3 {
+  margin-top: 40px;
+  margin-bottom: 10px;
+  font-size: 20px;
+  font-family: $font-family-primary;
+  i.fas, .symbol {
+    font-size: 14px;
+    margin-right: 5px;
+  }
+}
+
+h4 {
+  margin-top: 30px;
+  margin-bottom: 5px;
+  font-family: $font-family-primary;
+  font-weight: 600;
   i.fas, .symbol {
     font-size: 14px;
     margin-right: 5px;
   }
 }
 
+p + ul {
+  margin-top: 5px;
+  margin-bottom: 20px;
+}
+
+p {
+  margin-top: 15px;
+  margin-bottom: 5px;
+}
+
 hr {
   height: 1px;
   background-color: $gray-400;
@@ -311,7 +345,7 @@ button.ad-collapsible, .ad-collapsible {
       list-style: none;
       margin: 0;
       ul {
-        padding-left: 15px;
+        padding-left: 25px;
         list-style: none;
       }
     }
@@ -329,7 +363,7 @@ button.ad-collapsible, .ad-collapsible {
     border: 1px solid $gray-400;
     box-sizing: border-box;
     border-spacing: 0;
-    font-size: 13px;
+    font-size: 14px;
     td, th {
       border-right: 1px solid $gray-400;
       border-bottom: 1px solid $gray-400;
@@ -376,7 +410,7 @@ button.ad-collapsible, .ad-collapsible {
   justify-content: flex-start;
   flex-wrap: wrap;
   .ad-system_component {
-    min-width: 200px;
+    min-width: 120px;
     flex: 1;
     display: flex;
     flex-direction: column;
@@ -466,3 +500,43 @@ pre.highlight {
   }
 
 }
+
+.highlighter-rouge.language-scss {
+  .c1 {
+    color: #aaa;
+  }
+  .nv {
+    color: #e00bbc;
+    font-weight: bold;
+  }
+  .nt {
+    color: #0b11d8;
+    font-weight: bold;
+  }
+  .nc {
+    color: #cea513;
+    font-weight: bold;
+  }
+}
+
+.highlighter-rouge.language-ruby {
+  .n { color: blue; }
+  .ss { color: #34bad8; }
+  .s1 { color: #189c41; }
+  .c1 { color: #aaa; }
+}
+
+.highlighter-rouge.language-bash {
+  .nv { color: blue; }
+  .nb { color: #189c41; }
+  .nt { color: #34bad8; }
+  .c { color: #aaa; }
+}
+
+.highlighter-rouge.language-javascript {
+  .nv { color: #cea513; }
+  .nx { color: blue; }
+  .nt { color: #34bad8; }
+  .c1 { color: #aaa; }
+  .kd { color: #cea513; font-weight: bold; }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-alta-docs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tom Antas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -90,6 +90,13 @@ files:
 - LICENSE.txt
 - README.md
 - _includes/footer.html
+- _includes/guidelines/rails/api_only_project_tree.md
+- _includes/guidelines/rails/api_only_project_tree_with_files.md
+- _includes/guidelines/rails/api_only_psql_no_admin_setup_instructions.md
+- _includes/guidelines/rails/rails_cheatsheet.md
+- _includes/guidelines/react/react_csr_setup_instructions.md
+- _includes/guidelines/react/react_guidelines.md
+- _includes/guidelines/react/react_project_tree.md
 - _includes/head.html
 - _includes/head_scripts.html
 - _includes/nav.html
@@ -98,6 +105,8 @@ files:
 - _includes/scripts.html
 - _includes/sidebar.html
 - _includes/system_components_overview.html
+- _includes/templates/rails/rails_readme.md
+- _includes/templates/react/react_readme.md
 - _includes/useful_links.html
 - _layouts/default.html
 - _layouts/doc.html