Merge pull request #559 from sylhare/ramp-up

Improve documentation

Author: sylhare

.github/DISCUSSION_TEMPLATE/show-and-tell.yml

@@ -0,0 +1,23 @@
+title: "[Show] "
+labels: [showcase]
+body:
+  - type: markdown
+    attributes:
+      value: "## Share your site built with Type on Strap 🎉"
+  - type: input
+    id: site-url
+    attributes:
+      label: Site URL
+      placeholder: "https://your-site.github.io"
+    validations:
+      required: true
+  - type: input
+    id: repo-url
+    attributes:
+      label: Repo URL (optional)
+      placeholder: "https://github.com/you/your-site"
+  - type: textarea
+    id: description
+    attributes:
+      label: Tell us about it
+      description: What's your site about? Any customizations you're proud of?

README.md

@@ -6,24 +6,21 @@
 
 [![Default Type on Strap blog](https://github.com/Sylhare/Type-on-Strap/blob/master/assets/img/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)
 
-A free and open-source [Jekyll](https://jekyllrb.com) theme. 
-Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily customizable:
+A feature-rich [Jekyll](https://jekyllrb.com) theme for writers, developers, and creatives — with portfolio, gallery, dark mode, search, KaTeX, and Mermaid out of the box.
 
 * Responsive design on all devices (🖥, 💻, 📱, ...)
-* Portfolio 🗂, Gallery 🖼 pages for your projects
-* Multi comments 💬 options  
-* Tags compatibility 🏷
-* Handle _Bootstrap_'ed pages: [Get Bootstrap](http://getbootstrap.com/)
-* 🔎 Search feature: [Simple-Jekyll-Search](https://github.com/sylhare/Simple-Jekyll-Search)
-* Math Rendering : [KateX](https://github.com/Khan/KaTeX)
-* Diagram Rendering: [Mermaid-js](https://github.com/mermaid-js/mermaid)
-* 🖋 Nice fonts: [Font Awesome](https://fontawesome.com/), [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro), [Pacifico](https://fonts.google.com/specimen/Pacifico?selection.family=Pacifico) 
-* Seo Tags: [Jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
-* 🛠 Syntax Highlighting: Easily customisable [Base16](https://github.com/chriskempson/base16)
-* 💡 Light and dark theme supported
-* Find free of rights images on [pexels](https://www.pexels.com/)
-
-> [Demo Site](https://sylhare.github.io/Type-on-Strap/) 
+* Portfolio 🗂 and Gallery 🖼 pages for your projects
+* Auto light and dark theme 💡 with manual toggle
+* Full-text 🔎 search: [Simple-Jekyll-Search](https://github.com/sylhare/Simple-Jekyll-Search)
+* Write equations natively with [KaTeX](https://github.com/Khan/KaTeX)
+* Render diagrams natively with [Mermaid](https://github.com/mermaid-js/mermaid)
+* Multi comments 💬 systems: Disqus, Giscus, Utterances, Cusdis
+* Compatible with [Bootstrap](http://getbootstrap.com/) for responsive, customizable layouts
+* SEO-ready with [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
+* Syntax highlighting with easily customizable [Base16](https://github.com/chriskempson/base16) themes
+* Tags 🏷, categories, archive, and pagination built in
+
+> [Demo Site](https://sylhare.github.io/Type-on-Strap/)
 
 ## Usage
 
@@ -644,3 +641,9 @@ This theme is licensed under the [MIT License (MIT)](/LICENSE)
 
 - Pictures from [Pexels](https://www.pexels.com/) are under Creative Commons Zero (CC0) license
 - Fonts are licensed under the [SIL Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
+
+## Credits
+
+Based on Rohan Chandra's [type-theme](https://github.com/rohanchandra/type-theme), extended with many additional features.
+
+[![Contributors](https://contrib.rocks/image?repo=sylhare/Type-on-Strap)](https://github.com/sylhare/Type-on-Strap/graphs/contributors)

_posts/2021-04-27-dark-mode.md

@@ -16,12 +16,12 @@ Here is a bit of everything, so you can check how the theme look, have fun! 👌
 ##### Level 5
 ###### Level 6
 
-# [Headers with links](http://localhost)
-## [Level 2](http://localhost)
-### [Level 3](http://localhost)
-#### [Level 4](http://localhost)
-##### [Level 5](http://localhost) 
-###### [Level 6](http://localhost)
+# [Headers with links](https://sylhare.github.io/Type-on-Strap)
+## [Level 2](https://sylhare.github.io/Type-on-Strap)
+### [Level 3](https://sylhare.github.io/Type-on-Strap)
+#### [Level 4](https://sylhare.github.io/Type-on-Strap)
+##### [Level 5](https://sylhare.github.io/Type-on-Strap) 
+###### [Level 6](https://sylhare.github.io/Type-on-Strap)
 
 ## Code highlight
 Mode specific code highlighting themes. [Kramdown](https://kramdown.gettalong.org/) which is responsible for the color highlighting may be more limited than your IDE.

type-on-strap.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sylhare", "Rohan Chandra"]
   spec.email         = ["sylhare@outlook.com", "hellorohan@outlook.com"]
 
-  spec.summary       = "A simple and responsive jekyll theme template"
-  spec.description   = %q{A simple and responsive jekyll theme template based on type-theme. Great for blogs, easy to customize and responsive.}
+  spec.summary       = "Feature-rich Jekyll theme with portfolio, gallery, dark mode, search, KaTeX and Mermaid"
+  spec.description   = %q{A free and open-source Jekyll theme for writers, developers, and creatives. Includes portfolio and gallery pages, auto dark/light mode, full-text search, KaTeX math rendering, Mermaid diagrams, multiple comment systems, and Bootstrap support. Works as a Ruby gem or remote theme.}
   spec.homepage      = "https://github.com/sylhare/Type-on-Strap"
   spec.license       = "MIT"