Improve Documentation

Help us to improve the documentation by identifying issues and suggesting changes.

Introduction

We welcome corrections and improvements to the documentation. Please note that the documentation resides in its own repository, separate from the project repository.

For corrections and improvements to the current documentation, please submit issues and pull requests to the documentation repository.

You can also:

• Submit showcase by editing the data/friends.yml file
• Submit theme components by editing the data/projects.lang.yml file

Prerequisites

To contribute to the documentation, you need to:

• Install Hugo with the extended version
• Install Go
• Install Git
• Install Node.js above version 18.0.0

Guidelines

First, fork this repository by clicking the fork button.

Next, clone your forked repo.

1

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

Then, install the dev dependencies.

1

npm install

And now you are ready to go!

Here are some useful commands.

1
2
3
4
5
6

# 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:

1

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 🎉