forked from drowl87/hextra_mirror
34 lines
2.0 KiB
Markdown
34 lines
2.0 KiB
Markdown
<p align="center">
|
|
<h1 align="center">Hextra</h1>
|
|
<p align="center">Modern, responsive, batteries-included Hugo theme for creating beautiful static websites.</p>
|
|
</p>
|
|
|
|
## 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, 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.
|
|
- **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.
|
|
|
|
## 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.
|
|
|
|
### Usage
|
|
|
|
Refer to the [documentation](https://imfing.github.io/hextra/docs) for more information.
|
|
|
|
## Contributing
|
|
|
|
This project is actively under development. Contributions are welcome!
|
|
|
|
## License
|
|
|
|
[MIT License](./LICENSE)
|