diff --git a/README.md b/README.md index 6e90e1498..10e8f5dea 100644 --- a/README.md +++ b/README.md @@ -188,34 +188,72 @@ For local development, you can make changes in the theme submodule and test the At first, fork [this repo](https://github.com/hugo-toha/toha). Then, follow the following steps to use the forked theme for local developments, -**Using the forked theme in your own site:** +#### Running the forked theme against the example site -If you want to run your local development against your own site, follow the following steps: +If your want to run your local development against this [example site](https://github.com/hugo-toha/hugo-toha.github.io), follow the following steps: ```bash -# add the original theme as a submodule of your site if you haven't done already -$ git submodule add https://github.com/hugo-toha/toha.git themes/toha -# navigate into the toha theme folder -$ cd themes/toha -# add your own fork as a remote -$ git remote add my-fork https://github.com//toha -# create a new branch for your changes -$ git checkout -b my-feature-branch +# go to exampleSite directory +$ cd exampleSite +# install hugo modules +$ hugo mod tidy +# install dependencies +$ hugo mod npm pack +$ npm install +# run the example site locally +$ hugo server -w ``` -**Using the forked theme in the example site:** +Now, you can make change in the theme and they will be reflected immediately on the running site. If you need to change any configuration, you can do that in the `config.yaml` file inside `exampleSite` folder. If you need to add any content or data, you can create the respective folder inside `exampleSite` directory and add your desired content or data there. -If your want to run your local development against this [example site](https://github.com/hugo-toha/hugo-toha.github.io), follow the following steps: +#### Running the forked theme against your own site + +If you want to run your local development against your own site, follow the following steps: + +**Replace the theme module:** + +Open your site's `go.mod` file and replace the `github.com/hugo-toha/toha/v4` with your forked repo's path. For example, if your forked repo is `github.com//toha`, then replace the `github.com/hugo-toha/toha/v4` with `github.com//toha/v4`. + +```go +module github.com/hugo-toha/hugo-toha.github.io + +go 1.19 + +require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect + +replace( + github.com/hugo-toha/toha/v4 => github.com//toha +) +``` + +For interactive development, you can replace the theme with your locally cloned fork. For example, if you have cloned your fork in `/home/my-projects/toha`, then replace the `github.com/hugo-toha/toha/v4` with `/home/my-projects/toha`. + +```go +module github.com/hugo-toha/hugo-toha.github.io + +go 1.19 + +require github.com/hugo-toha/toha/v4 v4.0.1-0.20231229170427-d3968ca711ef // indirect + +replace( + github.com/hugo-toha/toha/v4 => /home/my-projects/toha +) +``` + +**Update dependencies:** + +```bash +# update hugo modules +$ hugo mod tidy +# install dependencies +$ hugo mod npm pack +$ npm install +``` + +**Run your site locally:** ```bash -# clone the example site along with the submodules -$ git clone git@github.com:hugo-toha/hugo-toha.github.io.git --recursive -# navigate into the toha theme folder -$ cd themes/toha -# add your own fork as a remote -$ git remote add my-fork https://github.com//toha -# create a new branch for your changes -$ git checkout -b my-feature-branch +$ hugo server -w ``` From there you can make changes to the source code of the theme while testing with your running Hugo site or the example site. diff --git a/exampleSite/go.sum b/exampleSite/go.sum index 845d5cef5..9101a35b7 100644 --- a/exampleSite/go.sum +++ b/exampleSite/go.sum @@ -1,4 +1,2 @@ -github.com/hugo-toha/hugo-toha.github.io v0.0.0-20221228191121-007f31838bd6 h1:TPFhOZAnuH4wjLIdzimswCRa2qCcc1teKVTatADJU2g= -github.com/hugo-toha/hugo-toha.github.io v0.0.0-20221228191121-007f31838bd6/go.mod h1:OMMaP9Hh9NsKd41lVIazBQRPa0s6Z57AfJoY3DcCNNY= github.com/hugo-toha/hugo-toha.github.io v0.0.0-20231031082630-2c32a26d2207 h1:T71lEaGpHYpdy8yKM5vaVwm+CJGt8wjHvPgVM+GjCJM= github.com/hugo-toha/hugo-toha.github.io v0.0.0-20231031082630-2c32a26d2207/go.mod h1:aTn1lQX1rbcbfbwNuWHG/L5DPtD+bEzQro49QyFlbEg=