isabella232 / helix-example-basic

Basic Helix example, "content only", no programming required

Projec Helix: Basic Example

This basic example is your starting point to Helix.

Other Helix example repositories are found at https://github.com/topics/helix-example

Status

Prerequisites

TODO explain what's needed and point to the Getting Started guide

TODO

This example should be completed to demonstrate the following:

• content only: index.md (or use README.md as fallback?)
• custom header and footer: add header.md & footer.md
• add static html files
• custom styling: add style.css as override

And the tests in the test-code branch should be updated to validate those things.

Overview

So far this is more a skeleton than a complete example, it needs to be fleshed out but already demonstrates the idea of standalone examples including integration tests that validate them along with the whole publishing chain. Discussion at #27.

It demonstrates a basic website with a few pages, a header and a footer, all in Markdown format, along with a simple custom CSS stylesheet and a few images.

By default, this example Helix website is published at https://helix-example-basic-adobe.project-helix.page/ . If you forked this repository, replace adobe with your GitHub username in that URL.

To access other Helix examples use This GitHub query - each example is found in its own GitHub repository.

For more info on Helix see https://www.project-helix.io/

TODO: complete this example so it fits the below description

TODO: refine the GitHub query, in a specific org only?

How to play with this example

You can modifiy the *.md files at will and add new ones. Changes that are pushed to the master branch of this repository are published automatically, within a few seconds. TODO add caching info.

For now the only 'magic' files are header.md and footer.md, other files are considered to be pages of your Helix website.

Automated tests

This example is validated with CircleCI using tests defined in the test-code branch of this repository to avoid cluttering this branch with test code.

You can safely ignore these tests if you're just playing with the example.