Contest Content Template Usage Guide
Step 1β
Fork Heltec Wi-Ki repository, and clone the forked project into local. Copy the contest-content-template file in the news folder, rename it into your project name, lowercase, spaces are replaced by -.
Enter the folder and change the name of "contest-content-template.md" to the same as the parent directory.
Now your folder structure should look like this
Heltec_Docs_News/
βββ docs/ # Document Directory
β βββ devices/ # Wiki Document 1
β βββ platform/ # Wiki Document 2
β βββ intro.md
β βββ platforms.md
β
βββ news/ # Document Directory
β βββ my-project-name/ # Wiki Document 1
β β βββ img/
β β β βββ 01.svg
β β β βββ 02.png
β β β βββ 03.png
β β β βββ 04.png
β β β βββ ...
β β βββ my-project-name.md # Wiki in subdirectories
β βββ contest-content-template/ # Wiki Document 1
β βββ contest-content-template-usage-guide/ # Wiki Document 2
β βββ 2025-Heltec-Maker-Contest.md
β βββ 2025-Heltec-Maker-Contest-Privacy-Policy.md
β βββ authors.yml
β βββ tags.yml
β
βββ scripts/
β βββ ...
β
βββ src/
β βββ ...
βββ ...
Step 2β
Now you can start creating your project in the my-project-name.md file. Put the relevent pictures into the img directory under my-project-name. Submit a PR to Heltec Wi-Ki repository, then wait for review. After the review is passed, your post will be displayed on Heltec News Page.