https://github.com/hugo-fixit/docs

📄 The source for https://fixit.lruihao.cn
https://github.com/hugo-fixit/docs

documentation hugo hugo-blog hugo-theme-fixit

Last synced: about 9 hours ago
JSON representation

📄 The source for https://fixit.lruihao.cn

• Host: GitHub
• URL: https://github.com/hugo-fixit/docs
• Owner: hugo-fixit
• License: mit
• Created: 2022-07-23T12:17:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T09:36:54.000Z (4 months ago)
• Last Synced: 2024-10-21T13:44:44.039Z (4 months ago)
• Topics: documentation, hugo, hugo-blog, hugo-theme-fixit
• Language: Markdown
• Homepage: https://fixit.lruihao.cn
• Size: 14.8 MB
• Stars: 59
• Watchers: 2
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: README.en.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FixIt Theme Documentation

[![Production environment](https://img.shields.io/github/deployments/hugo-fixit/docs/Production?style=flat&label=Production&logo=vercel)](https://fixit.lruihao.cn/)

[![Preview environment](https://img.shields.io/github/deployments/hugo-fixit/docs/Preview?style=flat&label=Preview&logo=vercel)](https://pre.fixit.lruihao.cn/)

[![Hugo](https://img.shields.io/badge/Hugo-%5E0.140.0-ff4088?style=flat&logo=hugo)](https://gohugo.io/)

👉 [中文](README.md) | English

[FixIt](https://github.com/hugo-fixit/FixIt) theme documentation is mainly divided into: [Documentation](https://fixit.lruihao.cn/documentation/), [Guides](https://fixit.lruihao.cn/guides/) two major sections, welcome everyone to initiate a PR to improve the theme documentation.

## System requirements

- [Node.js](https://nodejs.org/): >= 18.0.0

- [Go](https://go.dev/dl/)

- [Hugo](https://gohugo.io/installation/): >= 0.140.0 (extended version)

## Contributing

First, fork this repository by clicking the fork button.

Next, clone your forked repo.

```bash

git clone https://github.com/hugo-fixit/docs.git fixit-docs && cd fixit-docs

```

Then, install the dev dependencies.

```bash

npm install

```

And now you are ready to go!

Here are some useful commands.

```bash

# run a local debugging server with watch

npm run server

# run a local debugging server with watch in production environment

npm run server:production

# see Edit the theme section

npm run server:development

```

## Participate in translation

Documents containing the `missing-translation` shortcode indicate that this part has not been translated yet. Click to view [documents with missing translations](https://github.com/search?q=repo%3Ahugo-fixit%2Fdocs+%7B%7B%3C+missing-translation+%3E%7D%7D&type=code).

## Edit the theme

If you want to do docs-related theme changes, the simplest way is to have both `fixit-docs` and `FixIt` cloned as sibling directories, and then run:

```bash

HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"

```

Finally, create a new pull request at  to submit your contribution 🎉

## Thanks for sponsoring

[translate.js](https://github.com/xnx3/translate) sponsors enterprise translation channel.