gaddevarunteja / codingdojo.org

Codingdojo web site

CodingDojo.org

This repo holds the content for CodingDojo.org and some tools to help you work on the site locally.

Contributing

If you want to contribute, first fork repos :

• Website.
• Theme.

Then clone your fork and the CodingDojo template:

git clone [email protected]:_your_account_/codingdojo.org.git
cd codingdojo.org

# themes are on a separate project that you need to clone too (don't worry, it's in the `.gitignore` for this repo)
git clone [email protected]:_your_account_/template-hugo-codingdojo themes/template-hugo-codingdojo

This site works with Hugo static site generator which you can either install locally or use through the provided Dockerfile.

Using Hugo locally

Note that the current version of Hugo (0.34 as of this writing) seems to have problems with the way the content is laid out in this repo. Older versions (like 0.26 in the Docker image) work fine.

# serve local files with live-reload
make hugo

Open your browser on http://localhost:1313 and start your favorite editor!

Using Hugo from the docker container

Assuming you have Docker installed, you build an image and run it:

make docker-dev
make hugo

Open your browser on http://localhost:1313 and start your favorite editor!

Content contribution

Add new pages

To add content create a new markdown file with this minimal front matter :

---
title: "The title of page"
date: "YYYY-MM-DD"
---

and submit a pull request.

To add a dojo session add your content in content/dojo/ directory, to add a new kata, use content/kata/ directory.

Translation

To translate a page, add a page named MyPage.LANG.md for exemple the french translation of FizzBuzz kata FizzBuzz.md is located in file FizzBuzz.fr.md

Special notes

Summaries

By default the engine will take the first 70s words of some content and use it as a summary. If you want to specify the summary part of your content, you just have to add this comment within your markdown content to define where the summary stops (from the beginning):

<!--more-->

(exactly like this, without spaces around more)

People

If you have an old page here (for your dojo, for yourself in people, etc) and want it to be removed without having to clone/install, just open an issue and ask for the removal. Other option, make a Pull Request.