Skip to content

Latest commit

 

History

History
54 lines (31 loc) · 3.76 KB

File metadata and controls

54 lines (31 loc) · 3.76 KB

Do you want to contribute?

The basics

This web page is generated by Jekyll a multi-compiler that builds html from MarkDown and Liquid and builds CSSfrom SASS. Plain and simple. It's based on a remote template thetechcollective/minimal-mistake which is forked from mmistakes/minimal-mistakes. The template is documented at Minimal Mistake's Quick Start Guide. We support all the features documented here - and a few more.

Jekyll is originally developed by GitHub with the specific purpose of supporting GitHub pages.

The codebase is automatically build every time a commit hist the main branch - Have a look at the actions.

The build is verified, in the same pipeline and if all checks out it's automatically deployed to www.thetechcollective.dev.

If you need help with anything that is not document here, feel free to ask in the discussions, that we have opened on this repository. Or to open an issue on the same repository.

Getting Access

Contact @lakruzz - either by a mention on a discussion or issue her in GitHub or on mail lakr@thetechcollective.ex

Start with creating a CodeSpace

Create a CodeSpace on this repository The build takes a while first time you do it.

Expand to see video tutorial

setup codespace

Build the website

Run the following in the terminal

bundle exec jekyll serve

All changes will become instantly live on the dev site on port 4000 (except changes in .yml files, they require the server to be stopped an restarted.

When you commit changes back to master and push to origin the GitHub Action will automatically start. If your code pass the quality gates, it will end up on the live website at www.thetechcollective.dev

Quality gates

The workflow will build the site with jekyll and then test for spelling error and correct MarkDown formatting. using cspell and markdownlint-cli2

workflow

If you want to test in your dev setup wether or not the workflow will pass the quality gates keep an eye on the Problems tab in the terminal window or you can run the same commands as the workflow executes cspell "_*/**.md" and run: markdownlint-cli2 "_*/**.md" respectively. In the terminal in your CodeSpace it translates to:

cspell "_*/**.md"
markdownlint-cli2 "_*/**.md"