Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.25 KB

Contributing

First off, thank you for your time and effort! This project is not very large and easy to jump into.

Development stack

  • Built with Hugo 🔥
  • Gulp as a build tool 🍹
  • Styles in Stylus 💅🏻
  • Yarn as a package manager 📦

Getting started

  1. Fork and clone the repository
  2. Install dependencies:
cd hugo-theme-codex

yarn install

Scripts

There are 3 npm scripts that can be used for development purposes:

yarn develop

This command will start a hugo webserver and serve the exampleSite. This works well because the example site uses hugo-theme-codex, so any changes we make to the codebase can be viewed in real time.

yarn watch:assets

If you are working with js or css you will probably want to run this command in a separate tab from yarn develop so that any changes to assets like javascript and css will trigger a re-build by `gulp``.

yarn build:assets

Triggers a one-time build of the static directory.

Questions

If you have any questions feel free to reach out to me directly. Best ways to contact me: