README.en.md

FixIt Theme Documentation

👉 中文 | English

FixIt theme documentation is mainly divided into: Documentation, Guides two major sections, welcome everyone to initiate a PR to improve the theme documentation.

System requirements

• Node.js: >= 18.0.0
• Go
• Hugo: >= 0.127.0 (extended version)

Contributing

First, fork this repository by clicking the fork button.

Next, clone your forked repo.

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

Then, install the dev dependencies.

npm install

And now you are ready to go!

Here are some useful commands.

# 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

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:

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

Finally, create a new pull request at https://github.com/hugo-fixit/docs/pulls to submit your contribution 🎉