hbstack / theme-cards Goto Github PK

View Code? Open in Web Editor NEW

23.0 3.0 7.0 2.18 MB

HB cards style theme for building fast, responsive, modern and modular static websites.

Home Page: https://theme-cards.hbstack.dev/

License: MIT License

Dockerfile 16.73% SCSS 25.63% TypeScript 1.91% HTML 55.74%

hb hb-theme hugo hugo-theme blog digital-garden docs bootstrap responsive

theme-cards's Introduction

HB Cards Theme

The cards theme of HB Framework, live demo: https://theme-cards.hbstack.dev/.

Documentation

English	简体中文
Install from scratch	从头开始安装
Migrate from starter theme	从新手模板迁移

Screenshot

Features

Fast and SEO friendly: PageSpeed Insight scored perfect 💯 in all four metrics on mobile and desktop.
Multi-purpose: blog, project documentation, digital gardens, landing pages and so on.
Responsive: mobile first, built on top of Bootstrap v5.3.
🧊 Modular and flexible: extend features via various modules.
🌓 Dark mode: light, dark or auto (follow system).
🔍 Search: powerful client side fuzzy search that allows filtering and sorting of results, as well as searching from all multilingual sites.
PurgeCSS: remove unused CSS.
🚀 PWA:
- Installable: add site to home screen.
- Offline available: offline page and offline image.
- Allow precaching resources, such as CSS, JS and fonts.
Advanced:
- Custom SCSS variables and style.
- Custom JavaScript.
- Custom HTML markup:
🖼️ Images Processing: process images via URL query string and fragment, such as alignment, resizing, cropping and so on, friendly to Markdown.
💻 Code block panel: expand toggle, code copy button, line number toggle and wrap toggle.
Menus: supports header menus and footer menus.
Related posts slide.
🖼️ Image viewer: zoom in/out image.
🗂️ Archives: group by year and month.
📝 Multiple authors: articles can be co-authored.
🌐 Multilingual.
⬅️ RTL: supports Right-to-Left languages.
⬆️ Back/Return to top button.
Social links: supports header and footer social links.
Content: supports KaTex (math), Mermaid (diagrams) and Bootstrap shortcodes.
...

theme-cards's People

Contributors

Stargazers

Watchers

Forkers

stardoom4 openllms naodeng nepalgg lituatui howisjames k-kipruto

theme-cards's Issues

Rewrite homepage to particular page

Hello , Is there a way to use the docs module as the Index page and blog module as a Blog page , like in Docusaurus.

removing sidebar

Is it possible to remove the sidebar or just the taxonomy , featured and recent section.

Create a prompt initializer

Can you please add the option to hide nav-search on desktop, but show on mobile ?

For example, on desktop as:

no mobile as:

I tried to hide the search on desktop with header/layouts/partials/hb/modules/header/index.html for hours , but it will also hidden on mobile.

any tip achieving on hiding the search on desktop, but shown on mobile(breakpoint). Thank you.

Is plugin about comment replaceable

Thanks for your work.
And i have a question as the title, which that comment plugin need authority of github. And this function could be disabled or replaceable.

can you please add github.com/hbstack/social-share-buttons to this theme ? Thank you.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile

Dockerfile

github-actions

.github/workflows/lint.yml

actions/checkout v4

actions/setup-node v4

.github/workflows/release-please.yml

google-github-actions/release-please-action v4

gomod

exampleSite/go.mod

go 1.19

github.com/GoogleChrome/workbox v7.1.0+incompatible

github.com/KaTeX/KaTeX v0.16.10

github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20200

github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000

github.com/hbstack/back-to-top v0.2.0

github.com/hbstack/base v0.6.1

github.com/hbstack/bigger-picture v0.10.1

github.com/hbstack/blog v0.37.0

github.com/hbstack/blog/modules/breadcrumb v0.1.23

github.com/hbstack/blog/modules/content-panel v0.1.21

github.com/hbstack/blog/modules/featured-image v0.2.21

github.com/hbstack/blog/modules/giscus v0.1.24

github.com/hbstack/blog/modules/heading-sign v0.1.23

github.com/hbstack/blog/modules/post-nav v0.4.0

github.com/hbstack/blog/modules/related-posts v0.4.0

github.com/hbstack/blog/modules/sidebar/posts v0.8.0

github.com/hbstack/blog/modules/sidebar/profile v1.3.0

github.com/hbstack/blog/modules/sidebar/taxonomies v0.5.0

github.com/hbstack/blog/modules/social-share-buttons v0.1.1

github.com/hbstack/blog/modules/toc-scrollspy v0.2.0

github.com/hbstack/bootstrap v0.2.2

github.com/hbstack/breadcrumb v0.7.3

github.com/hbstack/carousel v0.2.6

github.com/hbstack/code-block-panel v0.1.2

github.com/hbstack/content-panel v0.10.1

github.com/hbstack/docs v0.17.3

github.com/hbstack/docs/modules/breadcrumb v0.1.10

github.com/hbstack/docs/modules/content-panel v0.1.8

github.com/hbstack/docs/modules/doc-nav v0.3.7

github.com/hbstack/docs/modules/featured-image v0.2.8

github.com/hbstack/docs/modules/giscus v0.1.11

github.com/hbstack/docs/modules/heading-sign v0.1.9

github.com/hbstack/docs/modules/social-share-buttons v0.1.0

github.com/hbstack/docs/modules/toc-scrollspy v0.1.8

github.com/hbstack/featured-image v0.2.1

github.com/hbstack/footer v0.4.1

github.com/hbstack/footer/modules/socials v0.3.0

github.com/hbstack/giscus v0.1.1

github.com/hbstack/google-fonts v0.1.1

github.com/hbstack/hb v0.12.3

github.com/hbstack/header v0.14.6

github.com/hbstack/header/modules/language-picker v0.1.26

github.com/hbstack/header/modules/search v0.1.37

github.com/hbstack/header/modules/socials v0.2.1

github.com/hbstack/header/modules/theme-toggle v0.5.2

github.com/hbstack/heading-sign v0.2.0

github.com/hbstack/mermaid v0.2.2

github.com/hbstack/meta/recommended v0.2.10

github.com/hbstack/noscript v0.7.0

github.com/hbstack/pagination v0.8.0

github.com/hbstack/progress-bar v0.1.0

github.com/hbstack/pwa v0.1.2

github.com/hbstack/scrollbar v0.1.0

github.com/hbstack/search v0.2.2

github.com/hbstack/slide v0.4.0

github.com/hbstack/snackbar v0.1.2

github.com/hbstack/socials v0.16.0

github.com/hbstack/syntax-highlighting v0.2.0

github.com/hbstack/syntax-highlighting/styles/gruvbox v0.1.1

github.com/hbstack/theme-cards v0.1.1

github.com/hbstack/toc-scrollspy v0.1.0

github.com/henrygd/bigger-picture v1.1.17

github.com/hugomods/base v0.7.2

github.com/hugomods/bootstrap v0.22.2

github.com/hugomods/code-block-panel v0.7.0

github.com/hugomods/font-awesome v6.5.2+incompatible

github.com/hugomods/fuse-js v0.1.0

github.com/hugomods/giscus v0.1.1

github.com/hugomods/gravatar v0.2.0

github.com/hugomods/hugopress v0.5.0

github.com/hugomods/i18n-js v0.2.1

github.com/hugomods/icons v0.6.4

github.com/hugomods/icons/vendors/bootstrap v0.5.7

github.com/hugomods/icons/vendors/font-awesome v0.6.7

github.com/hugomods/icons/vendors/simple-icons v1.0.43

github.com/hugomods/idb-js v0.1.0

github.com/hugomods/images v0.11.0

github.com/hugomods/katex v0.3.2

github.com/hugomods/mermaid v0.1.1

github.com/hugomods/pwa v0.9.0

github.com/hugomods/search v0.14.0

github.com/hugomods/seo/modules/alternatives v0.1.1

github.com/hugomods/seo/modules/base v0.1.3

github.com/hugomods/seo/modules/favicons v0.2.2

github.com/hugomods/seo/modules/open-graph v0.1.1

github.com/hugomods/seo/modules/schema v0.1.3

github.com/hugomods/seo/modules/translations v0.1.1

github.com/hugomods/seo/modules/twitter-cards v0.1.1

github.com/hugomods/shortcodes v0.21.0

github.com/hugomods/simple-icons v12.3.0+incompatible

github.com/hugomods/snackbar v0.1.2

github.com/hugomods/workbox v0.1.0

github.com/jakearchibald/idb v8.0.0+incompatible

github.com/krisk/Fuse v7.0.0+incompatible

github.com/twbs/bootstrap v5.3.3+incompatible

github.com/twbs/icons v1.11.3

go.mod

go 1.19

github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20200

github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000

github.com/hbstack/base v0.6.1

github.com/hbstack/blog v0.37.0

github.com/hbstack/carousel v0.2.6

github.com/hbstack/footer v0.4.1

github.com/hbstack/hb v0.12.3

github.com/hbstack/header v0.14.6

github.com/hbstack/pagination v0.8.0

github.com/hbstack/socials v0.16.0

github.com/hugomods/base v0.7.2

github.com/hugomods/gravatar v0.2.0

github.com/hugomods/hugopress v0.5.0

github.com/hugomods/icons v0.6.4

github.com/hugomods/icons/vendors/bootstrap v0.5.7

github.com/hugomods/icons/vendors/simple-icons v1.0.43

github.com/hugomods/images v0.11.0

github.com/hugomods/seo/modules/base v0.1.3

github.com/hugomods/simple-icons v12.3.0+incompatible

github.com/twbs/bootstrap v5.3.3+incompatible

github.com/twbs/icons v1.11.3

npm

exampleSite/package.json

@fullhuman/postcss-purgecss ^6.0.0

autoprefixer ^10.4.14

decap-server ^3.0.1

postcss-cli ^11.0.0

rtlcss ^4.0.0

package.json

@tsconfig/recommended ^1.0.2

prettier ^3.0.0

prettier-plugin-go-template ^0.0.15

stylelint ^16.0.0

stylelint-config-standard-scss ^13.0.0

stylelint-scss ^6.0.0

ts-standard ^12.0.2

Check this box to trigger a request for Renovate to run again on this repository

How to host theme-cards on cloudflare with such cloudflare-pages.yaml ?

dev/exsite/.github/workflow
cat cloudflare-pages.yaml

name: Cloudflare Pages

on:
  # auto deploy when pushing to specified branches.
  push:
    branches:
      - main

  # allow triggering workflow manually.
  workflow_dispatch:

jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      deployments: write
    name: Publish to Cloudflare Pages
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: "19"

      - name: Cache dependencies
        uses: actions/cache@v3
        with:
          path: ~/.npm
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-            

      - name: Install dependencies
        run: npm ci

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: "latest"
          extended: true

      - name: Cache Hugo modules
        uses: actions/cache@v3
        with:
          path: /tmp/hugo_cache
          key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
          restore-keys: |
            ${{ runner.os }}-hugomod-            

      - name: Build
        run: hugo --minify --gc --enableGitInfo
        # Use following instead if defaultContentLanguageInSubdir is enabled.
        # run: hugo --minify --gc --enableGitInfo && cp public/en/404.html public/404.html

      - name: Publish to Cloudflare Pages
        uses: cloudflare/pages-action@v1
        with:
          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
          projectName: hb-theme
          directory: ./public
          # Optional: Enable this if you want to have GitHub Deployments triggered
          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

and CLOUDFLARE_API_TOKEN, CLOUDFLARE_ACCOUNT_ID are filled

Hide dates in docs

I'm building a documentation website. I read this discussion, tried everything, but I can't get rid of the date and time to read.
Please could you explain in detail how to proceed?
Thanks