refactor [various]: structural & stylesheet

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [Unreleased]
+
+- ...
+
+## [1.0.0] - 2017-09-30
+
+- Initial stable release
+
+[Unreleased]: https://github.com/MunifTanjim/minimo/compare/v1.0.0...HEAD

README.md

@@ -2,44 +2,24 @@
 
 A minimalist theme for Hugo.
 
-## Installation
+## Documentation
 
-There are two different ways you can install Minimo:
+Check the [Minimo Documentation](https://minimo.netlify.com/docs/) for detailed documentation of Minimo.
 
-1. As clone
-2. As submodule
+#### Getting Up & Running
 
-The second method is suggested.
+Follow these guides for getting your site up & running with Minimo:
 
-#### Install Minimo as clone
+- **Install Minimo**: [Installation Guide](https://minimo.netlify.com/docs/installation)
+- **Setup Authors**: [Authors Setup Guide](https://minimo.netlify.com/docs/authors)
 
-With this method, you will simply clone it. And a copy of Minimo's repository will be stored with the rest of you site. Enter the following command for cloning Minimo:
-
-    git clone https://github.com/MunifTanjim/minimo themes/minimo
-
-#### Install Minimo as submodule
-
-This method doesn't store a copy of Minimo's repository inside your site's repository. Rather it adds Minimo as a dependency. Start by this command:
-
-    git submodule add https://github.com/MunifTanjim/minimo themes/minimo
-
-This will add Minimo's repository as a submodule to your site's repository. Now, you will have to pull the theme:
-
-    git submodule init
-    git submodule update
-
-That's all, Minimo is ready to be used.
-
-## Configuration
-
-For getting started with Minimo, copy the `config.toml` file from the `exampleSite` directory inside Minimo's repository to your site repository:
+## Development
 
-    cp themes/minimo/exampleSite/config.toml .
+If you find a bug or want to request a new feature, feel free to open an issue.
 
-Now, you can start editing this file and add your own information!
+## Changelog
 
-## Development
-If you find a bug or want to request a new feature, feel free to open an issue.
+[Changelog for Minimo](/CHANGELOG.md)
 
 ## License
 Minimo is licensed under the MIT License. Check the [LICENSE](https://github.com/MunifTanjim/minimo/blob/master/LICENSE) file for details.

data/assets.json

@@ -1,6 +1,6 @@
 {
   "main": {
-    "js": "main.af838dd5.js",
-    "css": "main.18d4eae9.css"
+    "js": "main.f29c93b9.js",
+    "css": "main.f605bf05.css"
   }
 }

exampleSite/config.toml

@@ -11,7 +11,7 @@ googleAnalytics = ""
 Paginate = 5
 preserveTaxonomyNames = true
 
-# Syntax Highlighting: https://gohugo.io/content-management/syntax-highlighting/
+# Syntax Highlighting ( https://gohugo.io/content-management/syntax-highlighting/ )
 pygmentsCodefences = true
 
 [params.info]
@@ -35,7 +35,7 @@ suffix = ""
 dateFormat = "2006, Jan 2"
 hideEntryNavigation = false
 hideSocialMenu = false
-showReadTime = true
+showReadingTime = true
 
 [params.opengraph.facebook]
 admins = [] # array of Facebook IDs
@@ -65,16 +65,18 @@ page = "/:slug/"
 
 [[menu.main]]
 name = "Repo"
-weight = -70
+weight = -10
 identifier = "repository"
 url = "https://github.com/MunifTanjim/minimo"
 
+[blackfriday]
+hrefTargetBlank = true
+
 # Language Configuration
 defaultContentLanguage = "en"
 
 [languages]
 # edit this block for your own language
-
 [languages.en]
 lang = "en"
 languageName = "English"

exampleSite/content/blog/_index.md

@@ -1,5 +1,5 @@
 ---
 title: Blog
 menu: main
-weight: -220
+weight: -230
 ---

exampleSite/content/blog/minimo-v1.0.0.md

@@ -1,5 +1,5 @@
 ---
-date: 2017-09-28T18:00:00+06:00
+date: 2017-09-30T18:00:00+06:00
 title: Minimo v1.0.0 Released
 authors: ["muniftanjim"]
 categories:

exampleSite/content/docs/_index.md

@@ -2,6 +2,6 @@
 title: Documentation
 linkTitle: Docs
 menu: main
-weight: -220
+weight: -250
 slug: docs
 ---

exampleSite/content/docs/example-config-toml.md

@@ -24,13 +24,18 @@ googleAnalytics = ""
 Paginate = 5
 preserveTaxonomyNames = true
 
+# Syntax Highlighting ( https://gohugo.io/content-management/syntax-highlighting/ )
+pygmentsCodefences = true
+
 [params.info]
 description = "Minimalist theme for Hugo"
+title404 = "Nothing's here!"
 
 [params.assets]
 favicon = "favicon.ico"
 customCSS = ["css/custom.css"]
 customJS = ["js/custom.js"]
+gopher = "" # used in 404 template ( Generator: https://gopherize.me )
 
 [params.copyright]
 prefix = ""
@@ -43,7 +48,7 @@ suffix = ""
 dateFormat = "2006, Jan 2"
 hideEntryNavigation = false
 hideSocialMenu = false
-showReadTime = true
+showReadingTime = true
 
 [params.opengraph.facebook]
 admins = [] # array of Facebook IDs
@@ -73,16 +78,18 @@ page = "/:slug/"
 
 [[menu.main]]
 name = "Repo"
-weight = -70
+weight = -10
 identifier = "repository"
 url = "https://github.com/MunifTanjim/minimo"
 
+[blackfriday]
+hrefTargetBlank = true
+
 # Language Configuration
 defaultContentLanguage = "en"
 
 [languages]
 # edit this block for your own language
-
 [languages.en]
 lang = "en"
 languageName = "English"

exampleSite/content/docs/installation.md

@@ -5,6 +5,7 @@ authors: ["muniftanjim"]
 categories:
   - Tutorial
 slug: installation
+toc: true
 ---
 First of all you will need to setup a Hugo site. You can follow the [Hugo's Quick Start Guide](https://gohugo.io/getting-started/quick-start/) for that.
 

exampleSite/content/page/about.md

@@ -2,7 +2,7 @@
 title: About
 description: What does Minimo even means?!
 menu: main
-weight: -170
+weight: -210
 ---
 
 Mínimo is a Spanish word that roughly translate to Minimal.

exampleSite/content/page/typography.md

@@ -3,9 +3,9 @@ date: 2017-09-28T08:00:00+06:00
 title: Typography
 authors: ["muniftanjim"]
 slug: typography
+menu: main
+weight: -230
 ---
-# Heading 1
-
 Here is a paragraph. **Lorem ipsum _dolor_ sit amet**, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
 ## Heading 2

i18n/bn.toml

@@ -54,15 +54,21 @@ other = "আগের পোস্ট"
 [postedOn]
 other = "তারিখ"
 
+[readingTime]
+one = "এক মিনিট লম্বা"
+other = "{{ .Count }} মিনিট লম্বা"
+
 [recentPosts]
 other = "সাম্প্রতিক পোষ্টগুলো"
 
+[skipToContent]
+other = "কন্টেন্টে যাও"
+
 [socialMenu]
 other = "সোশ্যাল মেনু"
 
-[readingTime]
-one = "এক মিনিট লম্বা"
-other = "{{ .Count }} মিনিট লম্বা"
+[tableOfContents]
+other = "এক নজরে"
 
 [tag]
 one = "ট্যাগ"

i18n/en.toml

@@ -54,15 +54,21 @@ other = "Previous post"
 [postedOn]
 other = "Posted on"
 
+[readingTime]
+one = "One min read"
+other = "{{ .Count }} mins read"
+
 [recentPosts]
 other = "Recent Posts"
 
+[skipToContent]
+other = "Skip to Content"
+
 [socialMenu]
 other = "Social Menu"
 
-[readingTime]
-one = "One min read"
-other = "{{ .Count }} mins read"
+[tableOfContents]
+other = "Table of Contents"
 
 [tag]
 one = "Tag"

layouts/404.html

@@ -1,17 +1,24 @@
 {{ partial "header" . }}
 
-<main class='main'>
+<main id='main' class='main'>
   <div class='entry'>
     <div class='entry-content'>
+      <span class='screen-reader'>
+        {{- .Site.Params.Info.title404 | default .Title -}}
+      </span>
       <figure class='gopher'>
-        <img src='{{ ( .Site.Params.Assets.gopher | default "assets/gopher.png" ) | relURL }}' alt='{{ i18n "gopher" }}'>
+        <a href='{{ "/" | relLangURL }}'>
+          <img src='{{ ( .Site.Params.Assets.gopher | default "assets/gopher.png" ) | relURL }}' alt='{{ i18n "gopher" }}'/>
+          <span class='screen-reader'>
+            {{- i18n "goHome" -}}
+          </span>
+        </a>
         <figcaption>
           <h1 class='title'>
-            {{- .Site.Params.Info.title404 | default .Title -}}
+            <a href='{{ "/" | relLangURL }}'>
+              {{- .Site.Params.Info.title404 | default .Title -}}
+            </a>
           </h1>
-          <a href='{{ "/" | relLangURL }}'>
-            {{- i18n "goHome" -}}
-          </a>
         </figcaption>
       </figure>
     </div>

layouts/_default/li.html

@@ -8,6 +8,7 @@
         </time>
       </span>
     </div>
+
     <header class='list-item-header'>
       <h3 class='list-item-title'>
         <a href='{{ .Permalink | relURL }}'>

layouts/_default/list.html

@@ -1,28 +1,44 @@
 {{ partial "header" . }}
 
-<main class='main'>
-  <section class='list-container'>
-    <h1 class='list-title title'>
-      {{- if eq .Kind "taxonomy" -}}
-        <span class='taxonomy-type'>
-          {{- ( ( i18n .Data.Singular 1 ) | default .Data.Singular ) | title -}}
-          {{- print ": " -}}
-        </span>
-      {{- end -}}
-      {{- if eq .Data.Singular "author" -}}
-        {{- partial "data/author/displayName" . -}}
-      {{- else -}}
-        {{- .Title -}}
-      {{- end -}}
-    </h1>
+<main id='main' class='main'>
+
+  <header class='header-container'>
+    <div class='header list-header'>
+      <div class='header-info'>
+        <h1 class='title'>
+          {{- if eq .Kind "taxonomy" -}}
+          <span class='taxonomy-type'>
+            {{- ( ( i18n .Data.Singular 1 ) | default .Data.Singular ) | title -}}
+            {{- print ": " -}}
+          </span>
+          {{- end -}}
+          {{- if eq .Data.Singular "author" -}}
+            {{- partial "data/author/displayName" . -}}
+          {{- else -}}
+            {{- .Title -}}
+          {{- end -}}
+        </h1>
+
+        {{ partial "header/subtitle" . }}
+      </div>
+    </div>
+  </header>
+
+  {{ if .Content }}
+  <div class='entry'>
+    {{ partial "entry/content" . }}
+  </div>
+  {{ end }}
+
+  <div class='list-container'>
     <ul class='list'>
       {{ range .Paginator.Pages }}
         {{ .Render "li" }}
       {{ end }}
     </ul>
 
     {{ partial "nav/pagination" . }}
-  </section>
+  </div>
 </main>
 
 {{ partial "footer" . }}

layouts/_default/single.html

@@ -1,19 +1,14 @@
 {{ partial "header" . }}
 
-<main class='main'>
+<main id='main' class='main'>
   <article lang='{{ .Params.Lang | default .Lang }}' class='entry'>
     {{ partial "entry/header" . }}
+    {{ partial "entry/toc" . }}
     {{ partial "entry/content" . }}
     {{ partial "entry/footer" . }}
   </article>
-
-  {{ if not .Site.Params.Settings.HideEntryNavigation }}
-    {{ partial "nav/entry_nav" . }}
-  {{ end }}
-
-  {{ if not ( eq .Params.comments false ) }}
-    {{ partial "disqus" . }}
-  {{ end }}
+  {{ partial "nav/entry_nav" . }}
+  {{ partial "entry/comments" . }}
 </main>
 
 {{ partial "footer" . }}