mirror of
https://github.com/imfing/hextra.git
synced 2025-08-23 02:36:57 -04:00
30866e328c
* chore: remove standard development mode command from CLAUDE.md * docs(toc): add TOC scroll functionality documentation - Added detailed comments to toc-scroll.js explaining the purpose and functionality of the TOC scroll spy feature. - Clarified the requirements for proper operation, including the need for a .hextra-toc element and matching heading IDs. * refactor(fragments): enhance fragment processing and documentation - Improved the fragments.html partial to better handle page content splitting into searchable fragments based on headings. - Added comprehensive documentation within the file, detailing parameters, return values, and examples for clarity. - Updated content handling to ensure whitespace is trimmed * refactor(tags): enhance tag rendering and styling in toc - Updated the tags.html partial to utilize a context variable for improved accessibility. - Enhanced the styling of tag links for better visual consistency across different themes. - Modified toc.html and list.html to pass the context to the tags partial, ensuring consistent rendering. * chore: run `task css`
Hextra
English | 简体中文 ｜ فارسیModern, responsive, batteries-included Hugo theme for creating beautiful static websites.
Demo → imfing.github.io/hextra
Features
- Beautiful Design - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
- Responsive Layout and Dark Mode - It looks great on all devices, from mobile to desktop. Dark mode is also supported to accommodate various lighting conditions.
- Fast and Lightweight - Powered by Hugo, a lightning-fast static-site generator housed in a single binary file, Hextra keeps its footprint minimal. No JavaScript or Node.js are needed to use it.
- Full-text Search - Built-in offline full-text search powered by FlexSearch, no extra configuration required.
- Battery-included - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcrumbs, pagination, sidebar navigation and more are all automatically generated.
- Multi-language and SEO Ready - Multi-language sites made easy with Hugo's multilingual mode. Out-of-the-box support is included for SEO tags, Open Graph, and Twitter Cards.
Quick Start
Use the template
Using the Hextra Starter Template is the simplest method to bootstrap a new website with Hextra theme. Get started by clicking the "Use this template" button on the template repository page.
The template repository also includes a GitHub Actions workflow for deploying your website to GitHub Pages.
Usage
Refer to the documentation for more information.
Contributing
Contributions are welcome. Check out the contributing guide to get started.