mirror of
https://github.com/gomods/athens
synced 2026-02-03 11:00:32 +00:00
c2c5daf61a
* Switching to using the main default branch * changing links to main branch, not master branch * Changing a few links to relative * Bumping chart version Co-authored-by: Marwan Sulaiman <marwan.sameer@gmail.com>
19 lines
743 B
Markdown
19 lines
743 B
Markdown
---
|
|
title: "Docs"
|
|
date: 2018-11-01T13:58:58-07:00
|
|
weight: 2
|
|
LastModifierDisplayName: "Marwan"
|
|
LastModifierEmail: "marwan.sameer@gmail.com"
|
|
|
|
---
|
|
|
|
### Contributing To Docs
|
|
|
|
Contributing to docs is just as important, if not more important than, writing code. We use [GoHugo](https://gohugo.io/) to run this website. So if you'd like to improve it, here's how you can run it locally:
|
|
|
|
1. Install the Hugo binary: https://github.com/gohugoio/hugo#choose-how-to-install
|
|
2. `cd ./docs && hugo server`
|
|
|
|
The Hugo server will run on http://localhost:1313 and it will automatically watch your files and update the website every time you make a change.
|
|
|
|
Alternatively you can run our custom docker image as outlined [here](./DEVELOPMENT.md#run-the-docs) |