https://github.com/gethinode/mod-simple-datatables

A Hugo module to enhance tables powered by simple-datatables to your Hinode site
https://github.com/gethinode/mod-simple-datatables

Last synced: 2 months ago
JSON representation

A Hugo module to enhance tables powered by simple-datatables to your Hinode site

• Host: GitHub
• URL: https://github.com/gethinode/mod-simple-datatables
• Owner: gethinode
• License: mit
• Created: 2024-07-09T09:04:11.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-19T03:04:50.000Z (2 months ago)
• Last Synced: 2024-10-19T05:33:27.099Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 783 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hinode Module - Simple Datatables



    A Hugo module to enhance tables powered by simple-datatables to your Hinode site

    






    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



## About

![Logo](https://raw.githubusercontent.com/gethinode/hinode/main/static/img/logo.png)

Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Hinode is available as a [template][repository_template], and a [main theme][repository]. This repository maintains a Hugo module to add [simple-datatables][simple-datatables] to a Hinode site. Visit the Hinode documentation site for [installation instructions][hinode_docs].

## Contributing

This module uses [semantic-release][semantic-release] to automate the release of new versions. The package uses `husky` and `commitlint` to ensure commit messages adhere to the [Conventional Commits][conventionalcommits] specification. You can run `npx git-cz` from the terminal to help prepare the commit message.

## Usage

Simple datatables is compatible with Bootstrap tables. It uses Hugo's `i18n` folder for the translation tables of [multilingual sites][hugo_multilingual]. Add the attribute `data-table` to the class of any table. The following arguments are supported:

| Argument              | Default | Description |

|-----------------------|---------|-------------|

| data-table-sortable   | `true`  | Toggle the ability to sort the columns. |

| data-table-paging     | `true`  | Whether paging is enabled for the table. |

| data-table-searchable | `true`  | Toggle the ability to search the dataset. |

[hugo]: https://gohugo.io

[hugo_multilingual]: https://gohugo.io/content-management/multilingual/

[hinode_docs]: https://gethinode.com

[simple-datatables]: https://github.com/fiduswriter/simple-datatables/tree/main

[repository]: https://github.com/gethinode/hinode.git

[repository_template]: https://github.com/gethinode/template.git

[conventionalcommits]: https://www.conventionalcommits.org

[husky]: https://typicode.github.io/husky/

[semantic-release]: https://semantic-release.gitbook.io/