diff --git a/README.md b/README.md index c33baec..ff69617 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# Hextra +

+

Hextra

+

Modern, responsive, batteries-included Hugo theme for creating beautiful static websites.

+

+ +## Features + +- **Beautiful Design** - Inspired by Nextra, it uses Tailwind CSS to provide 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 within 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 configuration is 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 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 provides 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) to deploy your website to GitHub Pages. + +### Usage + +View the [documentation](https://imfing.github.io/hextra/docs) for more information. + +## Contributing + +This project is still in active development. +Contributions are welcome! + +## License + +[MIT License](./LICENSE)