-
Notifications
You must be signed in to change notification settings - Fork 43
Added the blog post template and user John Lee #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pedrominatel
wants to merge
2
commits into
espressif:main
Choose a base branch
from
pedrominatel:add-content-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
| title: "John Lee" | ||
| --- |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| --- | ||
| title: "Template for a blog post" | ||
| date: 2024-06-14 | ||
| draft: true | ||
| showAuthor: false | ||
| authors: | ||
| - "john-lee" | ||
| - "pedro-minatel" | ||
| tags: ["How to", "Hugo", "Template"] | ||
| categories: ["Tutorial"] | ||
| platforms: ["ESP-IDF"] | ||
| socs: ["ESP32-C6"] | ||
| --- | ||
|
|
||
| ## How to create a blog post on the Developer Portal | ||
|
|
||
| [Please see the contribution guideline](../../pages/contribution-guide/content-writing-workflow) | ||
|
|
||
| ## You can do: | ||
|
|
||
| Write your content in Markdown. | ||
|
|
||
| Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. It was created by John Gruber and Aaron Swartz in 2004 to help people "write using an easy-to-read and easy-to-write plain text format, optionally convert it to structurally valid XHTML (or HTML)". | ||
|
|
||
| ### Add images | ||
|
|
||
| Store all your images on inside the assets folder. | ||
|
|
||
|  | ||
|
|
||
| ### Add code block | ||
|
|
||
| {{< highlight c "linenos=table,hl_lines=">}} | ||
| #include <stdio.h> | ||
| #include "led_strip.h" | ||
|
|
||
| // 10MHz resolution, 1 tick = 0.1us (led strip needs a high resolution) | ||
| #define LED_STRIP_RMT_RES_HZ (10 * 1000 * 1000) | ||
|
|
||
| led_strip_handle_t led_strip; | ||
|
|
||
| void configure_led(void) | ||
| { | ||
| // LED strip general initialization, according to your led board design | ||
| led_strip_config_t strip_config = { | ||
| // Set the GPIO that the LED is connected | ||
| .strip_gpio_num = 8, | ||
| // Set the number of connected LEDs in the strip | ||
| .max_leds = 1, | ||
| // Set the pixel format of your LED strip | ||
| .led_pixel_format = LED_PIXEL_FORMAT_GRB, | ||
| // LED strip model | ||
| .led_model = LED_MODEL_WS2812, | ||
| // In some cases, the logic is inverted | ||
| .flags.invert_out = false, | ||
| }; | ||
|
|
||
| // LED strip backend configuration: RMT | ||
| led_strip_rmt_config_t rmt_config = { | ||
| // Set the clock source | ||
| .clk_src = RMT_CLK_SRC_DEFAULT, | ||
| // Set the RMT counter clock | ||
| .resolution_hz = LED_STRIP_RMT_RES_HZ, | ||
| // Set the DMA feature (not supported on the ESP32-C6) | ||
| .flags.with_dma = false, | ||
| }; | ||
|
|
||
| // LED Strip object handle | ||
| led_strip_new_rmt_device(&strip_config, &rmt_config, &led_strip); | ||
| } | ||
|
|
||
| void app_main(void) | ||
| { | ||
| configure_led(); | ||
| led_strip_set_pixel(led_strip, 0, 20, 0, 0); | ||
| led_strip_refresh(led_strip); | ||
| } | ||
| {{< /highlight >}} | ||
|
|
||
|
|
||
| You can highlight some specific lines on your code: | ||
|
|
||
| {{< highlight c "linenos=table,hl_lines=3 5 7 9 11" >}} | ||
| led_strip_config_t strip_config = { | ||
| // Set the GPIO8 that the LED is connected | ||
| .strip_gpio_num = 8, | ||
| // Set the number of connected LEDs, 1 | ||
| .max_leds = 1, | ||
| // Set the pixel format of your LED strip | ||
| .led_pixel_format = LED_PIXEL_FORMAT_GRB, | ||
| // LED model | ||
| .led_model = LED_MODEL_WS2812, | ||
| // In some cases, the logic is inverted | ||
| .flags.invert_out = false, | ||
| }; | ||
| {{< /highlight >}} | ||
|
|
||
| ### Add YouTube videos | ||
|
|
||
| {{< youtube D86gQ4knUnc >}} | ||
|
|
||
| ### Add Asciinema | ||
|
|
||
| [Please see the contribution guideline](../../pages/contribution-guide/asciinema-casts) | ||
|
|
||
| ### Flow Charts | ||
|
|
||
| [Please see the contribution guideline](../../pages/contribution-guide/content-writing-workflow) | ||
|
|
||
| ### Timeline | ||
|
|
||
| The following table shows ESP-IDF support of Espressif SoCs where alt text and alt text denote preview status and support, respectively. The preview support is usually limited in time and intended for beta versions of chips. Please use an ESP-IDF release where the desired SoC is already supported. | ||
|
|
||
| {{< timeline >}} | ||
|
|
||
| {{< timelineItem icon="github" header="ESP-IDF v4.4" badge="Service" subheader="Supported SoCs" >}} | ||
| {{< badge >}}ESP32{{< /badge >}} | ||
| {{< badge >}}ESP32-S2{{< /badge >}} | ||
| {{< badge >}}ESP32-C3{{< /badge >}} | ||
| {{< badge >}}ESP32-S3{{< /badge >}} | ||
| {{< /timelineItem >}} | ||
|
|
||
| {{< timelineItem icon="github" header="ESP-IDF v5.0" badge="Service" subheader="Supported SoCs" >}} | ||
| {{< badge >}}ESP32-C2{{< /badge >}} | ||
| {{< /timelineItem >}} | ||
|
|
||
| {{< timelineItem icon="github" header="ESP-IDF v5.1" badge="Service" subheader="Supported SoCs" >}} | ||
| {{< badge >}}ESP32-C6{{< /badge >}} | ||
| {{< badge >}}ESP32-H2{{< /badge >}} | ||
| {{< /timelineItem >}} | ||
|
|
||
| {{< timelineItem icon="github" header="ESP-IDF v5.2" badge="Service" subheader="Supported SoCs" >}} | ||
| {{< badge >}}ESP32{{< /badge >}} | ||
| {{< badge >}}ESP32-S2{{< /badge >}} | ||
| {{< badge >}}ESP32-C3{{< /badge >}} | ||
| {{< badge >}}ESP32-S3{{< /badge >}} | ||
| {{< /timelineItem >}} | ||
|
|
||
| {{< timelineItem icon="github" header="ESP-IDF v5.3" badge="Preview" subheader="Supported SoCs" >}} | ||
| {{< badge >}}ESP32-P4{{< /badge >}} | ||
| {{< badge >}}ESP32-C5{{< /badge >}} | ||
| {{< /timelineItem >}} | ||
|
|
||
| {{< /timeline >}} | ||
|
|
||
| ### Links | ||
|
|
||
| GitHub repository links | ||
|
|
||
| {{< github repo="espressif/esp-idf" >}} | ||
|
|
||
| ### Extra | ||
|
|
||
| Please see the [shortcodes](https://blowfish.page/docs/shortcodes/) for more features. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "name": "John Lee", | ||
| "image" : "img/authors/espressif.png", | ||
| "bio": "Espressif Systems", | ||
| "social": [ | ||
| { "twitter": "https://x.com/espressifsystem" }, | ||
| { "github": "https://github.com/espressif" } | ||
| ] | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.