Welcome! This is the repository that generates dev.trywilco.com. It contains all the source code and Markdown files we use to build and serve our documentation.
The documentation in this repository is meant to help anyone build new and amazing quests in Wilco, but we could also use your help improving it.
On each page of the website, you have an edit button, which will lead you directly to GitHub's editor. You can also create an issue, and we'll take a look at it right away.
This repository uses Jekyll with Just the Docs template to generate and serve a static HTML website directly from GitHub Pages.
Assuming Ruby, Jekyll and Bundler are installed on your computer:
-
Clone this repository.
-
Run
bundle install. -
Run
bundle exec jekyll serveto build your site and preview it atlocalhost:4000.The built site is stored in the directory
_site.
If you have Docker installed on your machine:
-
Clone this repository.
-
Run
docker compose up. Preview the site atlocalhost:4000. Livereload will automatically refresh your browser as changes are made.
Any commits to main trigger an automatic rebuild and deployment to dev.trywilco.com. You can see the deployment status here.