diff --git a/README.md b/README.md index 7863ffe..b798ca8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Navigation Power-ups** is a Visual Studio Code extension that enhances your file navigation experience by adding a left bar navigation tree to files that haven't it natively. The extension is designed to support a variety of file types, offering an easy-to-use interface for jumping between sections, headers, or requests within supported files. -Currently, the extension supports `.http` files, with plans to extend compatibility to Markdown files (`.md`) and others in the future. +Currently, the extension supports `.http` and `.md` files, feel free to add any other file types you miss. ## Features @@ -16,7 +16,7 @@ Currently, the extension supports `.http` files, with plans to extend compatibil | File Type | Description | Navigation Rules | |-----------|--------------------------------------------------|----------------------------------------------------------------------------------| | `.http` | HTTP request files | Navigation based on `###` for requests. Headers with more than `###` are sections.| -| `.md` | Markdown files *(Upcoming)* | Navigation based on `#`, `##`, `###`, etc. headers. | +| `.md` | Markdown files | Navigation based on headers (`#`, `##`, `###`, etc). | | More | Additional file types *(Planned for future)* | TBD | ## Setup @@ -29,6 +29,13 @@ Currently, the extension supports `.http` files, with plans to extend compatibil 4. **Real-time Updates**: As you make changes to the file (such as adding new sections, editing headers, or removing requests), the tree will update in real time to reflect these changes. +### Markdown Files + +To be able to see the navigation left menu in markdown files, you just need to open the file and click in the plugin icon in the left bar. + +![Markdown file support](image.png) + + ### HTTP Files In `.http` files, the extension uses the number of `#` characters to differentiate between sections and requests: @@ -36,7 +43,7 @@ In `.http` files, the extension uses the number of `#` characters to differentia - **Sections**: Any headers with more than three `#` characters (e.g., `#### Section`) are treated as higher-level sections. - **Requests**: Headers with exactly three `#` characters (e.g., `### request`) are treated as individual HTTP requests. -### Example of `.http` file structure: +#### Example of `.http` file structure: ![Http file example](./images/readme-httpfile-eg.png) diff --git a/images/readme-markdown-eg.png b/images/readme-markdown-eg.png new file mode 100644 index 0000000..bb49523 Binary files /dev/null and b/images/readme-markdown-eg.png differ