Merge pull request #2 from manics/theme-subtree

Replace blist satre theme submodule with subtree
sa-tre · Jul 3, 2024 · f62966b · f62966b
2 parents 4f2536e + 81787cc
commit f62966b
Show file tree

Hide file tree

Showing 87 changed files with 7,689 additions and 8 deletions.
diff --git a/.gitmodules b/.gitmodules
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,3 +3,5 @@ repos:
     rev: v3.1.0
     hooks:
       - id: prettier
+
+exclude: "^themes/blist-satre/(assets/css/site.css|assets/js/fuse\\.min\\.js|assets/js/search\\.js|exampleSite|i18n|CHANGELOG\\.md|README\\.md)"
diff --git a/hugo.toml b/hugo.toml
@@ -2,8 +2,8 @@ baseurl = "https://blist.vercel.app"
 metaDataFormat = "yaml"
 title = "Standard Architecture for Trusted Research Environments"
 
-# https://github.com/apvarun/blist-hugo-theme
-theme = "blist"
+# Modified version of https://github.com/apvarun/blist-hugo-theme/tree/25febab1a29af2f5e445e92e41715ff632133519
+theme = "blist-satre"
 
 DefaultContentLanguage = "en"
 DefaultContentLanguageInSubdir = true

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1 +1 @@
-themes/blist/package.json
+themes/blist-satre/package.json
diff --git a/themes/blist b/themes/blist
diff --git a/themes/blist-satre/.gitignore b/themes/blist-satre/.gitignore
@@ -0,0 +1,5 @@
+/.idea
+/node_modules
+/exampleSite/public
+/exampleSite/hugo_stats.json
+.DS_Store
diff --git a/themes/blist-satre/CHANGELOG.md b/themes/blist-satre/CHANGELOG.md
@@ -0,0 +1,89 @@
+# Changelog
+
+All the changes made to Blist theme for Hugo.
+
+## v2.1.0 - 2023-01-09
+
+### Added
+
+- Support multiple comment systems #64
+
+## v2.0.1 - 2022-12-27
+
+### Fixed
+
+- Page metadata layout in mobile #94
+
+## v2.0.0 - 2022-12-25
+
+### Added
+
+- BREAKING: Ability to specify social icons order #91
+- Table of contents support #84
+- Search customization #79
+- Option to skip showing thumbnail in post page #93
+- Added more social icons
+  - Mastodon #92
+  - XDA #83
+  - Telegram #83
+  - Buy me a coffee #83
+  - Google Scholar #85
+  - Facebook #90
+  - Behance #66
+  - Tiktok #77
+  - Stackoverflow #71
+
+### Fixed
+
+- Inline code block #78
+
+## v1.5.0 - 2022-08-11
+
+### Added
+
+- Ability to hide metadata via param hideMeta #37
+- Hide other languages option via param hideOtherLanguages
+- Add French support #53 #54 #55
+
+### Fixed
+
+- Fix broken Multilingual search
+
+## v1.4.0 - 2022-01-08
+
+### Added
+
+- Hamburger menu for mobile UI #23
+- Image logo support #24
+
+## v1.3.1 - 2021-11-28
+
+### Added
+
+- Adding xing support to social icons - #15
+- Fix: Adding missing whitespace between label and language in single page - #16
+- Fix: Readable Lastmod - #17
+
+## v1.3.0 - 2021-10-27
+
+### Added
+
+- Add YouTube & Instagram social icons - #9
+- Add i18n support - #11
+- Add 404 page - #13
+
+## v1.2.0 - 2021-07-18
+
+### Added
+
+- Add color customization for Intro and Social links blocks
+
+## v1.1.0 - 2021-07-17
+
+### Added
+
+- Add support for text search
+
+## v1.0.0 - 2021-07-16
+
+- Initial Release
diff --git a/themes/blist-satre/LICENSE b/themes/blist-satre/LICENSE
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Varun A P
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/themes/blist-satre/README.md b/themes/blist-satre/README.md
@@ -0,0 +1,207 @@
+# Blist theme for Hugo
+
+![Latest Release](https://img.shields.io/github/tag/apvarun/blist-hugo-theme.svg)
+![Blist hugo theme](https://img.shields.io/github/license/apvarun/blist-hugo-theme)
+![Hugo generator](https://img.shields.io/badge/generator-hugo-brightgreen)
+
+Blist is a clean and fast blog theme for your Hugo site.
+
+![Blist Icon](https://github.com/apvarun/blist-hugo-theme/raw/main/images/blist-logo.png)
+
+**Features:**
+
+- Responsive content / Mobile-optimized
+- Blog pagination
+- Customizable Text Search
+- Table of contents
+- Social links
+- Code highlighting
+- Color customization
+- Dark mode
+- Fast performance
+- SEO optimized
+- i18n support
+- Support comments systems
+  - Disqus (hugo native)
+  - giscus
+  - utterances
+
+## Preview
+
+![Preview](https://github.com/apvarun/blist-hugo-theme/raw/main/images/screenshot.png)
+
+➡️ [DEMO](https://blist.vercel.app/)
+
+## Get the theme
+
+Minimum Hugo Version: **0.110.0**
+
+Run from the root of your Hugo site:
+
+```sh
+git clone https://github.com/apvarun/blist-hugo-theme.git themes/blist
+```
+
+Alternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well:
+
+```sh
+git submodule add https://github.com/apvarun/blist-hugo-theme.git themes/blist
+```
+
+## Preview the theme with example content
+
+Blist theme ships with an fully configured example site. For a quick preview:
+
+Copy the `package.json` file from `themes/blist` folder to your hugo website root folder, and run `npm install`.
+
+```sh
+cd themes/blist/exampleSite/
+hugo serve --themesDir ../..
+```
+
+Then visit `http://localhost:1313/` in your browser to view the example site.
+
+## Configuring theme to a hugo website
+
+1. Copy `package.json` and `package-lock.json` to the root folder of your website
+2. Run `npm install` to install required packages for theme
+3. Run `npm i -g postcss-cli` to use PostCSS with Hugo build
+4. Set `theme = 'blist'` in config.toml
+5. Run `npm start` to start your local server
+
+Make sure to commit the above changes to your repository.
+
+## Publish your website
+
+When deploying to services like Netlify or Vercel, use the following command for building your site:
+
+```sh
+npm i && HUGO_ENVIRONMENT=production hugo --gc
+```
+The parameter `HUGO_ENVIRONMENT=production` enables the execution of css purging.
+
+## Add content
+
+The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder.
+
+### Structure:
+
+    .
+    ├── ...
+    ├── blog       # Blog Section
+    │   ├── post1   # Post 1
+    │   ├── post2   # Post 2
+    │   └── _index
+    └── ...
+
+## Configure your site
+
+From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided.
+
+### Menu
+
+Menu in Blist theme is pre-set to have all section names. You can include custom links in header using the `menu.main` option config.toml.
+
+### Logo
+
+`logo` param in the site config will allow to use an image as the logo instead of the website name. It is localizable and so can have different logo for different languages
+
+### Darkmode
+
+`[params.darkModeToggle]` enables the dark mode toggle in header. The preference is then saved so that the mode is automatically chosen for return visits.
+
+### Customize Ascent Color
+
+Use `[params.ascentColor]` to change the default `pink` color to any supported color from the [list of default colors](https://tailwindcss.com/docs/customizing-colors) from Tailwind CSS.
+
+Some example values: bg-blue-200, bg-yellow-300
+
+### Search
+
+`[params.enableSearch]` option is used to enable search option in the theme.
+
+- Adds the search icon in header
+- Generates the search index
+- Uses fuse.js to enable searching through content
+
+In order to search, you can either click on the search icon from header or press `Ctrl/Cmd + /` key combination.
+
+**Note:**
+
+Make sure to enable JSON in outputs array.
+
+```
+[outputs]
+  home = ["HTML", "RSS", "JSON"]
+```
+
+### LaTeX
+
+Enable mathematical options: set `math: true` in your markdown frontmatter
+
+### Google Analytics
+
+Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics).
+
+## Performance
+
+[![Pagespeed Insights Performance](https://github.com/apvarun/blist-hugo-theme/raw/main/images/pagespeed-performance.png)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fblist.vercel.app&tab=mobile)
+
+## Issues
+
+If you have a question, please [open an issue](https://github.com/apvarun/blist-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better!
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/apvarun"><img alt="apvarun"
+          src="https://avatars.githubusercontent.com/u/8411309?v=4" width="117" /><br />apvarun</a></td>
+    <td align="center"><a href="https://github.com/Ravinou"><img alt="Ravinou"
+          src="https://avatars.githubusercontent.com/u/39600829?v=4" width="117" /><br />Ravinou</a></td>
+    <td align="center"><a href="https://github.com/engel-b"><img alt="engel-b"
+          src="https://avatars.githubusercontent.com/u/5812810?v=4" width="117" /><br />engel-b</a></td>
+    <td align="center"><a href="https://github.com/chris-gillatt"><img alt="chris-gillatt"
+          src="https://avatars.githubusercontent.com/u/9963006?v=4" width="117" /><br />chris-gillatt</a></td>
+    <td align="center"><a href="https://github.com/apps/dependabot"><img alt="dependabot[bot]"
+          src="https://avatars.githubusercontent.com/in/29110?v=4" width="117" /><br />dependabot[bot]</a></td>
+    <td align="center"><a href="https://github.com/xLexip"><img alt="xLexip"
+          src="https://avatars.githubusercontent.com/u/46321162?v=4" width="117" /><br />xLexip</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/AntoineSoetewey"><img alt="AntoineSoetewey"
+          src="https://avatars.githubusercontent.com/u/17910063?v=4" width="117" /><br />AntoineSoetewey</a></td>
+    <td align="center"><a href="https://github.com/chiragksharma"><img alt="chiragksharma"
+          src="https://avatars.githubusercontent.com/u/74889769?v=4" width="117" /><br />chiragksharma</a></td>
+    <td align="center"><a href="https://github.com/dlecan"><img alt="dlecan"
+          src="https://avatars.githubusercontent.com/u/586631?v=4" width="117" /><br />dlecan</a></td>
+    <td align="center"><a href="https://github.com/jpiaskowski"><img alt="jpiaskowski"
+          src="https://avatars.githubusercontent.com/u/8420943?v=4" width="117" /><br />jpiaskowski</a></td>
+    <td align="center"><a href="https://github.com/lucab85"><img alt="lucab85"
+          src="https://avatars.githubusercontent.com/u/24267107?v=4" width="117" /><br />lucab85</a></td>
+    <td align="center"><a href="https://github.com/Marty"><img alt="Marty"
+          src="https://avatars.githubusercontent.com/u/100658?v=4" width="117" /><br />Marty</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/ernavdeepkr"><img alt="ernavdeepkr"
+          src="https://avatars.githubusercontent.com/u/50796185?v=4" width="117" /><br />ernavdeepkr</a></td>
+    <td align="center"><a href="https://github.com/roypeter"><img alt="roypeter"
+          src="https://avatars.githubusercontent.com/u/16620459?v=4" width="117" /><br />roypeter</a></td>
+    <td align="center"><a href="https://github.com/janvanveldhuizen"><img alt="janvanveldhuizen"
+      src="https://avatars.githubusercontent.com/u/43573150?v=4" width="117" /><br />janvanveldhuizen</a></td>
+    <td align="center"><a href="https://github.com/jmflaherty"><img alt="jmflaherty"
+      src="https://avatars.githubusercontent.com/u/12985011?v=4" width="117" /><br />jmflaherty</a></td>
+  </tr>
+</table>
+
+## License
+
+Licensed under [MIT](LICENSE)
+
+## 🤝 Support
+
+Give a ⭐️ if you like this project!
+
+<a href="https://www.buymeacoffee.com/apvarun" target="_blank" rel="noopener"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" width="145" alt="Buy Me A Coffee"></a>
diff --git a/themes/blist-satre/archetypes/default.md b/themes/blist-satre/archetypes/default.md
@@ -0,0 +1,2 @@
++++
++++
diff --git a/themes/blist-satre/assets/css/paginator.css b/themes/blist-satre/assets/css/paginator.css
@@ -0,0 +1,15 @@
+.pagination {
+  @apply inline-flex border rounded px-1 dark:border-gray-600;
+}
+.page-item {
+  @apply mx-0.5 my-1 cursor-pointer rounded hover:bg-gray-800 hover:text-white dark:hover:bg-gray-500 dark:hover:text-white;
+}
+a.page-link {
+  @apply px-3 py-1 block;
+}
+.page-item.active {
+  @apply bg-gray-800 text-white dark:bg-gray-300 dark:text-gray-900;
+}
+.page-item.disabled {
+  @apply text-gray-400 hover:bg-transparent hover:text-gray-400 cursor-not-allowed;
+}
diff --git a/themes/blist-satre/assets/css/postcss.config.js b/themes/blist-satre/assets/css/postcss.config.js
@@ -0,0 +1,13 @@
+const themeDir = __dirname + "/../../";
+
+module.exports = {
+  plugins: [
+    require("postcss-import")({
+      path: [themeDir],
+    }),
+    require("tailwindcss")(themeDir + "assets/css/tailwind.config.js"),
+    require("autoprefixer")({
+      path: [themeDir],
+    }),
+  ],
+};