diff options
| author | Rafed Muhammad Yasir <rafed123@yahoo.com> | 2020-04-23 00:56:37 +0300 |
|---|---|---|
| committer | Rafed Muhammad Yasir <rafed123@yahoo.com> | 2020-04-23 00:56:37 +0300 |
| commit | 23aa63bbeb96a5b69a857c66d481d4a5d4a9b57e (patch) | |
| tree | 0c83afcf2544b44e6df37dc7327098cd1ff83b3d | |
| parent | b5d0d7ed8c8f312e90ada3fbe317fb672ecc70c7 (diff) | |
Updated theme
33 files changed, 272 insertions, 47 deletions
@@ -1,2 +1,139 @@ # Ramium A modern hugo theme for awesome blogs + + + + +## Features + +#### Site features + +- Google search bar +- Google Analytics +- Social sharing bar (facebook, twitter, reddit) +- Comments with Disqus +- Customizable navbar +- {{<local href="/admin" text="Admin panel">}} (Not a real admin panel though. It simply shows the summary of the total number of posts, tags and sections) +- Mobile responsive- works great across desktops, tablets and mobiles +- SEO friendly (Opengraph, Twitter cards) + +#### Blogging features + +- Attractive landing page with navigation links everywhere +- Add featured images to posts +- Add code snippets +- Add tags to articles and lislt articles by tags +- Making sections for related articles (for example tutorials on a topic) +- Add chord to lyrics (CSS style for [ChordSheetJs](https://github.com/martijnversluis/ChordSheetJS)) + +## Installation & Update + +``` +$ # install +$ mkdir themes +$ cd themes +$ git submodule add https://github.com/rafed/ramium.git ramium + +$ # update +$ git submodule update --remote --merge +``` + +If you want to know more information, see [Hugo doc](https://gohugo.io/themes/installing/). + +## Usage + +When you manually create files by following [quick start (step4)](https://gohugo.io/getting-started/quick-start/#step-4-add-some-content), you should command `hugo new posts/<filename>.md` instead of `hugo new posts/<filename>.md`. + +#### `config.toml` example + +``` +baseURL = "https://rafed.github.io/ramium/" +#CanonifyURLs=true + +languageCode = "en-us" +theme = "ramium" + +title = "Ramium" +disqusShortname = "rafed" +googleAnalytics = "googra" +summaryLength = 40 +pluralizeListTitles = false +enableemoji = false + +[params] + description = "A description for the meta tag of the site" + googleSearch = "google-search-key" + showDate = true # make false if dont want to show date + math = false # best to enable this in the front matter of a page + githubLink = "rafed/ramium/" + + tagsInHome = 40 + sectionsInHome = 5 + paginatePostsPerPage = 5 + paginateTagsPerPage = 6 + +[taxonomies] + tag = "tags" + +[markup.goldmark.renderer] + unsafe = true + +[menu] + [[menu.main]] + name = "Home" + url = "/" + weight = 1 + + [[menu.main]] + identifier = "blog" + name = "This Blog" + weight = 2 + [[menu.main]] + parent = "blog" + name = "All Tags" + url = "/tags/" + weight = 1 + [[menu.main]] + parent = "blog" + name = "All Sections" + url = "/sections/" + weight = 2 + [[menu.main]] + parent = "blog" + name = "All Posts" + url = "/posts/" + weight = 3 + + [[menu.main]] + name = "Author" + url = "/authorr/" + weight = 3 + +[permalinks] + posts = "/:section/:title/" + getting-started-with-ramium = "/:section/:title/" + introduction-to-ramium = "/:section/:title/" +``` + +## Frontmatter example + +``` +--- +title: {{ replace .Name "-" " " | title }} +date: {{ now.Format "2006-01-2" }} +tags: [tag1, tag2] +image: "/image/blog-pic.jpg" +description: "A smalll description" +showDate: true/false # to enable/disable showing dates +math: true # to enable showing equations (katex) +chordsheet: true # to add chordsheet styelsheet +--- +``` + +## Contributing + +If you find problems with the theme raise an issue. Also, contributions/pull requests are welcome. + +## LICENSE + +[MIT](./LICENSE).
\ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..4535518 --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,15 @@ +--- +title: {{ replace .Name "-" " " | title }} +date: {{ now.Format "2006-01-2" }} +tags: [tag1, tag2] +image: "/image/blog-pic.jpg" +--- + +Article goes here. + +For other options, put these in the front matter: + description: "A description" other than the blog intro + draft: true to not publish article yet + showDate: true/false to enable/disable showing dates + math: true to enable showing equations (katex) + chordsheet: true to add chordsheet styelsheet diff --git a/exampleSite/config.toml b/exampleSite/config.toml index db1451a..0e0c9aa 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,21 +1,22 @@ -baseURL = "https://rafed.github.io/ramium/" +baseURL = "https://example.com/" #CanonifyURLs=true languageCode = "en-us" theme = "ramium" title = "Ramium" -disqusShortname = "rafed123" -googleAnalytics = "googra" +disqusShortname = " +googleAnalytics = summaryLength = 40 pluralizeListTitles = false enableemoji = false [params] description = "A description for the meta tag of the site" - googleSearch = "000151824860492892407:kd5zijxwj6a" + googleSearch = showDate = true # make false if dont want to show date math = false # best to enable this in the front matter of a page + githubLink = "rafed/ramium/" tagsInHome = 40 sectionsInHome = 5 diff --git a/exampleSite/content/addons/admin.md b/exampleSite/content/addons/admin.md index 6341d9b..c6f119f 100644 --- a/exampleSite/content/addons/admin.md +++ b/exampleSite/content/addons/admin.md @@ -2,7 +2,7 @@ date: 2020-04-06T02:07:30+06:00 title: "Admin Panel" draft: false -type: "Addons" +type: "addons" layout: "admin" url: "/admin/" --- diff --git a/exampleSite/content/addons/author.md b/exampleSite/content/addons/author.md index 72bd60a..d220901 100644 --- a/exampleSite/content/addons/author.md +++ b/exampleSite/content/addons/author.md @@ -2,12 +2,10 @@ date: 2020-04-06T02:07:31+06:00 title: "About Author" draft: false -type: "Addons" +type: "addons" layout: "author" url: "/author/" -image: "/image/rafed.jpg" +image: "/image/profile.png" --- -Hello it's Devra! To know more about me go to [rafed.github.io](https://rafed.github.io). - -I hope you like this theme. I've tried to make it powerful, useful and easy to use. If you like it give it a star at [github.com/rafed/ramium](https://github.com/rafed/ramium).
\ No newline at end of file +I am John Doe. And I can confirm that this is the best theme ever!
\ No newline at end of file diff --git a/exampleSite/content/addons/authorRa.md b/exampleSite/content/addons/authorRa.md new file mode 100644 index 0000000..d7d92a5 --- /dev/null +++ b/exampleSite/content/addons/authorRa.md @@ -0,0 +1,13 @@ +--- +date: 2020-04-06T02:07:31+06:00 +title: "About Author" +draft: false +type: "addons" +layout: "author" +url: "/authorr/" +image: "/image/rafed.jpg" +--- + +Hello it's Devra! To know more about me go to [rafed.github.io](https://rafed.github.io). + +I hope you like this theme. I've tried to make it powerful, useful and easy to use. If you like it give it a star at [github.com/rafed/ramium](https://github.com/rafed/ramium).
\ No newline at end of file diff --git a/exampleSite/content/addons/sections.md b/exampleSite/content/addons/sections.md index a4a8a05..0f3a146 100644 --- a/exampleSite/content/addons/sections.md +++ b/exampleSite/content/addons/sections.md @@ -2,7 +2,7 @@ date: 2020-04-06T02:07:30+06:00 title: "All Sections" draft: false -type: "Addons" +type: "addons" layout: "sections" url: "/sections/" --- diff --git a/exampleSite/content/introduction-to-ramium/1. About Ramium.md b/exampleSite/content/introduction-to-ramium/1. About Ramium.md index cfd3c4d..a0909cd 100644 --- a/exampleSite/content/introduction-to-ramium/1. About Ramium.md +++ b/exampleSite/content/introduction-to-ramium/1. About Ramium.md @@ -2,11 +2,10 @@ title: About Ramium date: 2020-03-17 tags: ["Ramium"] -image: "/image/rafed.jpg" --- Ramium is an awesome hugo theme for creating personal blogs. Apparently, none of the existing hugo themes were what I wanted them to be for my new blog. Or maybe I just could not find the right one. So I took upon the courtesy of making the perfect one for my own. And thus takes the birth of Ramium that I'm very proud of. Coding this theme has been very fun. Special thanks go to [Hugo](https://gohugo.io/), which is not only the world’s fastest framework for building websites but an amazing one as well. This theme exists because Hugo exists. Also a big thanks to [Bulma](https://bulma.io/), which is an open source CSS framework based on Flexbox. It was eye refreshing to see a site with layouts not from bootstrap. -Check out all the [features of Ramium!](/ramium/introduction-to-ramium/features-of-ramium/) Or start using Ramium by following the [tutorial here!](/ramium/introduction-to-ramium/) +Check out all the {{<local href="/introduction-to-ramium/features-of-ramium/" text="features of Ramium">}} Or start using Ramium by following the {{<local href="/getting-started-with-ramium/" text="tutorial here.">}} diff --git a/exampleSite/content/introduction-to-ramium/2. Features of Ramium.md b/exampleSite/content/introduction-to-ramium/2. Features of Ramium.md index c0850b0..20b1129 100644 --- a/exampleSite/content/introduction-to-ramium/2. Features of Ramium.md +++ b/exampleSite/content/introduction-to-ramium/2. Features of Ramium.md @@ -14,18 +14,20 @@ Ramium is Packed with awesome features that makes your blog powerful and easy to - Social sharing bar (facebook, twitter, reddit) - Comments with Disqus - Customizable navbar -- Admin panel (Not a real admin panel though, since it's a static site. Just a panel to view a summary of the total nuimber of posts, tags and sections) -- Mobile friendly- works great across desktops, tablets and mobiles +- {{<local href="/admin" text="Admin panel">}} (Not a real admin panel though. It simply shows the summary of the total number of posts, tags and sections) +- Mobile responsive- works great across desktops, tablets and mobiles - SEO friendly (Opengraph, Twitter cards) ### Blogging features -- Attractive landing page with easily navigable links -- Adding featured images to posts -- Add tags to articles and filter by the tags -- Making sections for grouped articles (like for tutorials, or related articles) +- Attractive landing page with navigation links everywhere +- Add featured images to posts +- Add code snippets +- Add tags to articles and lislt articles by tags +- Making sections for related articles (for example tutorials on a topic) +- Add chord to lyrics (CSS style for [ChordSheetJs](https://github.com/martijnversluis/ChordSheetJS)) ### Future plans -- Post suggestion after articles based on tags +- Suggestions for reading more articles at the end of an article - Support for facebook comments - Google adsense diff --git a/exampleSite/content/posts/2. placeholder-text.md b/exampleSite/content/posts/2. placeholder-text.md index 71bee07..ba990e4 100644 --- a/exampleSite/content/posts/2. placeholder-text.md +++ b/exampleSite/content/posts/2. placeholder-text.md @@ -3,6 +3,7 @@ title: "Placeholder Text" date: 2020-04-15 description: "Lorem Ipsum Dolor Si Amet" tags: ["markdown", "text"] +draft: true --- Lorem est tota propiore conpellat pectoribus de diff --git a/exampleSite/content/posts/6. Happy birthday chords.md b/exampleSite/content/posts/6. Happy birthday chords.md new file mode 100644 index 0000000..135358d --- /dev/null +++ b/exampleSite/content/posts/6. Happy birthday chords.md @@ -0,0 +1,10 @@ +--- +title: Happy Birthday Chords +date: 2020-04-11 +description: Chords for Happy Birthday Song +tags: ["chords", "music"] +chordsheet: true +image: "/image/staff.jpg" +--- + +<div class="chord-sheet"><div class="paragraph"></div><div class="paragraph"><div class="row"><div class="column"><div class="chord"></div><div class="lyrics">Happy </div></div><div class="column"><div class="chord">A</div><div class="lyrics">Birthday </div></div><div class="column"><div class="chord">E</div><div class="lyrics">to you</div></div></div><div class="row"><div class="column"><div class="chord"></div><div class="lyrics">Happy </div></div><div class="column"><div class="chord">E</div><div class="lyrics">Birthday </div></div><div class="column"><div class="chord">A</div><div class="lyrics">to you</div></div></div><div class="row"><div class="column"><div class="chord"></div><div class="lyrics">Happy </div></div><div class="column"><div class="chord">A7</div><div class="lyrics">Birthday dear </div></div><div class="column"><div class="chord">D</div><div class="lyrics">Johnny</div></div></div><div class="row"><div class="column"><div class="chord"></div><div class="lyrics">Happy </div></div><div class="column"><div class="chord">A</div><div class="lyrics">Birthday </div></div><div class="column"><div class="chord">E</div><div class="lyrics">to </div></div><div class="column"><div class="chord">A</div><div class="lyrics">you</div></div></div></div><div class="paragraph"></div></div> diff --git a/exampleSite/static/image/favicon.ico b/exampleSite/static/image/favicon.ico Binary files differnew file mode 100644 index 0000000..34af764 --- /dev/null +++ b/exampleSite/static/image/favicon.ico diff --git a/exampleSite/static/image/profile.png b/exampleSite/static/image/profile.png Binary files differnew file mode 100644 index 0000000..dc7be62 --- /dev/null +++ b/exampleSite/static/image/profile.png diff --git a/exampleSite/static/image/staff.jpg b/exampleSite/static/image/staff.jpg Binary files differnew file mode 100644 index 0000000..41f2848 --- /dev/null +++ b/exampleSite/static/image/staff.jpg diff --git a/images/archive.png b/images/archive.png Binary files differnew file mode 100644 index 0000000..e05db1c --- /dev/null +++ b/images/archive.png diff --git a/images/post.png b/images/post.png Binary files differnew file mode 100644 index 0000000..2a5871b --- /dev/null +++ b/images/post.png diff --git a/images/tn.png b/images/tn.png Binary files differnew file mode 100644 index 0000000..2ece0fe --- /dev/null +++ b/images/tn.png diff --git a/layouts/404.html b/layouts/404.html index 5ff93c3..b587f88 100644 --- a/layouts/404.html +++ b/layouts/404.html @@ -50,6 +50,7 @@ </div> </div> </div> +<br> <div class="columns is-centered has-text-centered"> <div class="column is-10"> @@ -70,7 +71,7 @@ </div> </div> </div> - +<br> <div class="columns is-centered"> <div class="column is-7"> diff --git a/layouts/_default/single.html b/layouts/_default/single.html index fa08540..0567a59 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -45,7 +45,6 @@ {{- partial "social-media-share.html" -}} <br> -{{ template "_internal/disqus.html" }} -<!-- {{ partial "disqus.html" . }} --> +{{ partial "disqus.html" . }} {{ end }}
\ No newline at end of file diff --git a/layouts/Addons/admin.html b/layouts/addons/admin.html index 2dae096..488e492 100644 --- a/layouts/Addons/admin.html +++ b/layouts/addons/admin.html @@ -3,7 +3,7 @@ <div class="content"> <h1 class="title">Admin Panel</h1> - {{ $total_articles := len (where .Site.RegularPages "Section" "not in" "Addons") }} + {{ $total_articles := len (where .Site.RegularPages "Section" "not in" "addons") }} {{ $total_tags := len ($.Site.GetPage "taxonomyTerm" "tags").Pages }} {{ $total_sections := len (where .Site.Sections "Title" "not in" "Posts Addons") }} @@ -81,9 +81,17 @@ {{ end }} </table> + {{ $drafts := where .Site.RegularPages ".Draft" "==" true }} + {{ if $drafts }} + <h2>Drafted summary</h2> + <ol> + {{ range $drafts }} + <li>{{ .Title }}</li> + {{ end }} + </ol> + {{ end }} </div> </section> </div> - {{ end }}
\ No newline at end of file diff --git a/layouts/Addons/author.html b/layouts/addons/author.html index ccb9434..ccb9434 100644 --- a/layouts/Addons/author.html +++ b/layouts/addons/author.html diff --git a/layouts/Addons/sections.html b/layouts/addons/sections.html index b2c1a00..fb5a66b 100644 --- a/layouts/Addons/sections.html +++ b/layouts/addons/sections.html @@ -8,8 +8,9 @@ {{ $sections := where .Site.Sections.ByTitle ".Title" "not in" "Posts Addons" }} {{ range $i, $e := $sections }} + <a href="{{ $e.RelPermalink }}"> - <h1 class="title is-4"> {{ add $i 1 }}. {{ $e.Title | humanize | title }}</h1> + <p class="subtitle is-4"> {{ add $i 1 }}. {{ $e.Title | humanize | title }}</p> </a> {{ end }} </div> diff --git a/layouts/index.html b/layouts/index.html index 61fe13a..ef2664d 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -44,6 +44,7 @@ </div> </div> </div> +<br> <div class="columns is-centered has-text-centered"> <div class="column is-10"> @@ -64,7 +65,7 @@ </div> </div> </div> - +<br> <div class="columns is-centered"> <div class="column is-7"> diff --git a/layouts/partials/blog-brief.html b/layouts/partials/blog-brief.html index 7fb290f..338f93a 100644 --- a/layouts/partials/blog-brief.html +++ b/layouts/partials/blog-brief.html @@ -43,7 +43,11 @@ <div> <a href="{{ .RelPermalink }}"> - <p class="summary">{{ .Summary | plainify }}</p> + <p class="summary"> + {{ with .Description }}{{ . }} + {{ else }}{{ with .Summary }}{{ . | plainify }} + {{ end }}{{ end }} + </p> </a> </div> </div> diff --git a/layouts/partials/disqus.html b/layouts/partials/disqus.html index 4cb97bf..1e10bd7 100644 --- a/layouts/partials/disqus.html +++ b/layouts/partials/disqus.html @@ -12,6 +12,4 @@ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); </script> -<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by - Disqus.</a></noscript> -<a href="http://disqus.com/" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
\ No newline at end of file +<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
\ No newline at end of file diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 0df2e75..57183bd 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -6,11 +6,11 @@ <footer class="footer has-background-dark"> <div class="content has-text-centered has-text-white"> <p> - © 2020 Ramium. Site powered by + © 2020 Ramium. Powered by <a class="has-text-light" href="https://github.com/gohugoio/hugo" target="_blank"> - Hugo</a> and + Hugo</a>. Theme <a class="has-text-light" href="https://github.com/rafed123/ramium/" target="_blank"> - Ramium theme. + Ramium. </a> </p> </div> diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 6e69817..f3e6a8a 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -31,6 +31,10 @@ <script src={{ "/js/ramium.js" | relURL }}></script> <link rel="stylesheet" href={{ "/css/ramium.css" | relURL }}> +{{ if .Params.chordsheet }} +<link rel="stylesheet" href={{ "/css/chordsheet.css" | relURL }}> +{{ end }} + {{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }}
\ No newline at end of file diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index c49bb01..dad2335 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -36,8 +36,14 @@ {{ end }} </div> - {{ with .Site.Params.GoogleSearch }} <div class="navbar-end"> + {{ with .Site.Params.GithubLink }} + <a class="navbar-item navgithub" href="https://github.com/{{ . }}" target="_blank"> + <i class="fa fa-github fa-2x"></i> + </a> + {{ end }} + + {{ with .Site.Params.GoogleSearch }} <div class="navbar-item"> <form id="cse-search-box-form-id" onsubmit="return executeQuery();" role="search"> <div class="field has-addons"> @@ -55,7 +61,7 @@ </div> </form> </div> + {{ end }} </div> - {{ end }} </div> -</nav> +</nav>
\ No newline at end of file diff --git a/layouts/posts/list.html b/layouts/posts/list.html index 2c2c2c7..5f4ee02 100644 --- a/layouts/posts/list.html +++ b/layouts/posts/list.html @@ -4,7 +4,7 @@ <h1 class="title is-3">{{ .Title }}</h1> </div> -{{ $paginator := .Paginate (where .Site.RegularPages.ByDate.Reverse ".Section" "!=" "addons") .Site.Params.PaginatePostsPerPage }} +{{ $paginator := .Paginate (where .Site.RegularPages.ByDate.Reverse ".Section" "not in" "addons") .Site.Params.PaginatePostsPerPage }} {{ range $paginator.Pages }} {{- partial "blog-brief.html" . -}} {{ end }} diff --git a/layouts/shortcodes/local.html b/layouts/shortcodes/local.html new file mode 100644 index 0000000..75938ea --- /dev/null +++ b/layouts/shortcodes/local.html @@ -0,0 +1,3 @@ +{{ if .IsNamedParams }} +<a href="{{.Get "href" | relURL }}">{{.Get "text" }}</a> +{{ end }}
\ No newline at end of file diff --git a/static/css/chordsheet.css b/static/css/chordsheet.css new file mode 100644 index 0000000..74c0b72 --- /dev/null +++ b/static/css/chordsheet.css @@ -0,0 +1,26 @@ +.chord-sheet h1 { + color:red; +} + +.chord-sheet .row { + margin-bottom: 0.5em; +} + +.chord-sheet .column { + display: inline-block; + padding: 0; + margin-right: 0.5em; +} + +.chord-sheet .chord { + color: rgb(0, 0, 180); + font-weight: 600; +} + +.chord-sheet .lyrics { + font-size: 0.9em; +} + +.chord-sheet .paragraph { + margin-bottom: 3em; +}
\ No newline at end of file diff --git a/static/css/ramium.css b/static/css/ramium.css index 4cf0c05..001f755 100644 --- a/static/css/ramium.css +++ b/static/css/ramium.css @@ -165,7 +165,7 @@ h1.title.is-3 { /**************/ -.sections-list h1 { +.sections-list p { line-height: 1.5em; } @@ -3,21 +3,19 @@ name = "Ramium" license = "MIT" -licenselink = "https://github.com/rafed123/ramium/blob/master/LICENSE" -description = "" -homepage = "http://rafed123.github.io/ramium" -tags = [] -features = [] +licenselink = "https://github.com/rafed/ramium/blob/master/LICENSE" +description = "A modern hugo theme for awesome blogs" +homepage = "http://rafed.github.io/ramium/" +tags = ["blog", "responsive", "google analytics", "disqus"] +features = ["chordsheetjs", "admin panel", "social media share"] min_version = "0.572" [author] name = "Rafed Muhammad Yasir" - homepage = "rafed123.github.io" + homepage = "rafed.github.io/" # If porting an existing theme [original] name = "" homepage = "" repo = "" - -pluralizeListTitles = false
\ No newline at end of file |
