Important
Copy and paste the content of this file into README.md or face automatic disqualification
All headlines and subheadlines shall be retained if not noted otherwise.
Fill in text in each section as instructed and then delete the existing text, including this blockquote.
You can find a very good reference to Github flavoured markdown reference in this cheatsheet. If you want something a bit more WYSIWYG for editing then could use StackEdit which provides a more user friendly interface for generating the Markdown code. Those of you who are VS Code fans can edit/preview directly in that interface too.
⟹ Write the name of your Hackathon team here
⟹ Write the name of the selected category
⟹ Write a clear description of your hackathon entry.
- Module Purpose
- What problem was solved (if any)
- How does this module solve it
You can alternately paste a link here to a document within this repo containing the description.
⟹ Provide a video highlighing your Hackathon module submission and provide a link to the video. You can use any video hosting, file share or even upload the video to this repository. Just remember to update the link below
⟹ Does your module rely on other Sitecore modules or frameworks?
- List any dependencies
- Or other modules that must be installed
- Or services that must be enabled/configured
Remove this subsection if your entry does not have any prerequisites other than Sitecore
⟹ Write a short clear step-wise instruction on how to install your module.
A simple well-described installation process is required to win the Hackathon.
Feel free to use any of the following tools/formats as part of the installation:
- Sitecore Package files
- Docker image builds
- Sitecore CLI
- msbuild
- npm / yarn
Do not use
- TDS
- Unicorn
for example:
- Use the Sitecore Installation wizard to install the package
- ...
- profit
⟹ If there are any custom configuration that has to be set manually then remember to add all details here.
Remove this subsection if your entry does not require any configuration that is not fully covered in the installation instructions already
⟹ Provide documentation about your module, how do the users use your module, where are things located, what do the icons mean, are there any secret shortcuts etc.
Include screenshots where necessary. You can add images to the ./images folder and then link to them from your documentation:
You can embed images of different formats too:
And you can embed external images too:
If you'd like to make additional comments that is important for your module entry.