diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4383d5c9..19980c241 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ First, fork this repository by clicking the fork button. Next, clone your forked repo. ```bash -git clone --recursive https://github.com/hugo-fixit/FixIt.git && cd FixIt +git clone https://github.com/hugo-fixit/FixIt.git && cd FixIt ``` Then, install the dev dependencies. @@ -27,6 +27,12 @@ npm run server npm run server:production ``` +If you want to do docs-related theme changes, the simplest way is to have both `FixIt` and `fixit-docs` cloned as sibling directories, and then run: + +```bash +npm run server:docs +``` + Finally, create a new pull request at to submit your contribution 🎉 ## Git standard for developers diff --git a/package.json b/package.json index 0686f995c..6ffea6008 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ "build": "hugo -v --source=demo --gc --minify", "server": "hugo server --source=demo -D --disableFastRender --navigateToChanged --ignoreCache --bind 0.0.0.0", "server:production": "npm run server -- -e production", + "server:docs": "hugo server --source=../fixit-docs -D --disableFastRender --navigateToChanged --ignoreCache --bind 0.0.0.0", "version": "sed -i '' \"s/v$npm_package_version-RC/v$npm_package_version/g\" layouts/partials/init/index.html && git add .", "postversion": "git push && git push --tags" }