mirror of
https://github.com/imfing/hextra.git
synced 2025-06-19 23:01:19 -04:00
chore: compile css and update docs
chore: replace --debug with --logLevel debug chore: add copyright text
This commit is contained in:
@ -3,7 +3,21 @@ linkTitle: "Documentation"
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
**Hextra** is a modern, responsive, and powerful [Hugo](https://gohugo.io/) theme built with [Tailwind CSS](https://tailwindcss.com/).
|
||||
It is inspired by Next.js theme [Nextra](https://github.com/shuding/nextra).
|
||||
Welcome to the Hextra documentation!
|
||||
|
||||
Hextra is designed for building websites for documentation, blogs, and landing pages. It is elegant and easy to use out of the box, but also highly customizable to fit your needs.
|
||||
|
||||
## What is Hextra?
|
||||
|
||||
**Hextra** is a modern, responsive and powerful [Hugo](https://gohugo.io/) theme built with [Tailwind CSS](https://tailwindcss.com/), inspired by Next.js theme [Nextra](https://github.com/shuding/nextra).
|
||||
It is designed for building websites for documentation, blogs, books and landing pages.
|
||||
It is elegant and easy to use out of the box, but also highly customizable to fit your needs.
|
||||
|
||||
### Features
|
||||
|
||||
- **Fast** - Built with Hugo and Tailwind CSS, Hextra is extremely fast.
|
||||
|
||||
## Why Hextra?
|
||||
|
||||
Hextra is based on [Hugo](https://gohugo.io/), a static site generator written in Go, which means you can build your website once and host it anywhere.
|
||||
|
||||
Unlike Next.js, Hugo is **extremely fast**, which enables us to focus on iterating the content and previewing the changes in real time.
|
||||
|
48
exampleSite/content/docs/getting-started.md
Normal file
48
exampleSite/content/docs/getting-started.md
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Getting Started
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Start as New Project
|
||||
|
||||
Before we start, make sure we have [Hugo](https://gohugo.io/) installed. We also need to have Git and Go installed if we want to use Hugo modules.
|
||||
Please refer to Hugo's [official installation guide](https://gohugo.io/installation/) for more details.
|
||||
|
||||
{{% steps %}}
|
||||
|
||||
### Initialize a new Hugo site
|
||||
|
||||
```bash
|
||||
$ hugo new site my-site --format=yaml
|
||||
```
|
||||
|
||||
### Configure Hextra theme
|
||||
|
||||
[Hugo modules](https://gohugo.io/hugo-modules/) are the recommended way to manage Hugo themes.
|
||||
|
||||
```shell
|
||||
# initialize hugo module
|
||||
$ cd my-site
|
||||
$ hugo mod init github.com/username/my-site
|
||||
|
||||
# add Hextra theme
|
||||
$ hugo mod get github.com/imfing/hextra
|
||||
```
|
||||
|
||||
Edit `config.yaml` to enable Hextra theme:
|
||||
|
||||
```yaml
|
||||
module:
|
||||
imports:
|
||||
- path: github.com/imfing/hextra
|
||||
```
|
||||
|
||||
### Run Hugo server
|
||||
|
||||
```shell
|
||||
$ hugo server -D
|
||||
```
|
||||
|
||||
Voila! You can see your new site at `http://localhost:1313/`.
|
||||
|
||||
{{% /steps %}}
|
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Advanced
|
||||
---
|
||||
|
||||
Advanced topics.
|
@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Introduction
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Hextra is a modern, responsive Hugo theme built with [Tailwind CSS](https://tailwindcss.com/).
|
Reference in New Issue
Block a user