hextra/README.md

41 lines
2.4 KiB
Markdown
Raw Normal View History

2023-08-27 20:51:07 +01:00
<div align="center">
2023-08-27 19:50:09 +01:00
<h1 align="center">Hextra</h1>
<p align="center">Modern, responsive, batteries-included Hugo theme for creating beautiful static websites.</p>
2023-08-27 20:51:07 +01:00
Demo → [imfing.github.io/hextra](https://imfing.github.io/hextra/)
</div>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/5097752/263550533-c18343ca-3848-4230-b5c0-ee989d7916da.png">
<img alt="Hextra" src="https://user-images.githubusercontent.com/5097752/263550528-663599f9-17a1-4686-b5c4-3da233b5034d.png">
</picture>
2023-08-27 19:50:09 +01:00
## Features
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
2023-08-27 19:50:09 +01:00
- **Responsive Layout and Dark Mode** - It looks great on all devices, from mobile, tablet to desktop. Dark mode is also supported to accomodate 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 additional configuration required.
2023-08-27 19:50:09 +01:00
- **Battery-included** - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcumbs, 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.
2023-08-27 19:50:09 +01:00
## Quick Start
### Use the template
Using the [Hextra Starter Template](https://github.com/imfing/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](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) for deploying your website to GitHub Pages.
2023-08-27 19:50:09 +01:00
### Usage
Refer to the [documentation](https://imfing.github.io/hextra/docs) for more information.
2023-08-27 19:50:09 +01:00
## Contributing
This project is actively under development. Contributions are welcome!
2023-08-27 19:50:09 +01:00
## License
[MIT License](./LICENSE)