The Guide TOC Assistant is a Visual Studio Code extension designed to streamline the process of working with guides written in Markdown. One of the main challenges in editing documentation in VS Code is locating the correct files. This extension addresses this issue by providing a table of contents based on the mkdocs.yml file for the guide, enabling users to quickly locate and edit a file.
Features
Displaying Table of Contents
The extension extracts the guide structure from the mkdocs.yml file and displays it in an interactive form.
File Structure
The extension provides a visual representation of the hierarchical structure of your documentation, making it easy to understand and navigate.
Quick Navigation
You can click on any entry in the table of contents to open the corresponding file.
Requirements
You must have Node.js installed to use the extension.
Checking Node.js Installation
Use this procedure to verify whether the Node.js application is installed.
Open the Command Prompt.
Use the following command to check the Node.js version.
node -v
Output example:
v16.14.2
If the version displays, Node.js is installed.
For information about installing Node.js, see How to install Node.js. You can also install Node.js using the SEE Installer.
Usage
Displaying the table of contents
Open the local repository in Visual Studio Code.
Open Visual Studio Code.
Click File in the top menu bar.
Select Open Folder.
Locate the local repository with the guide files.
Select the repository.
Click the list icon () in the left sidebar to display the table of contents.
The Guide TOC Assistant window with the table of contents for the guide displays.
Opening a file
In the displayed table of contents, locate the title of the procedure or topic you want to open.
Click on the title to open the corresponding file.
The file displays in a new window. You can edit the opened file, or locate a different one in the table of contents.
Limitations
The Guide TOC Assistant extension works only with guides that contain the mkdocs.yml file with a specified structure.
Contributing
Contributions are always welcome! If you find any bugs or want to improve the extension, please open an issue or submit a pull request.
Fork the repository.
Create a new branch.
git checkout -b feature/your-feature
Commit your changes.
git commit -m 'Add new feature'
Push to the branch.
git push origin feature/your-feature
Open a pull request.
Release Notes
1.0.0
Initial release
2.0.0
New:
Moved the Table of Contents window to the left sidebar.
The TOC can now be displayed without locating and opening the mkdocs.yml file.
Fixed:
The text is now clearly visible both in the light theme and the dark theme.
2.0.1
Fixed:
Added verification to check if there is an open directory in the current workspace.
2.1.0
New:
Extension removes all unnecessary spaces.
New font (Lucida Console).
Title of the guide is displayed.
Fixed:
Commented lines are not displayed.
Resolved the issue with additional data appearing at the beginning.
2.1.1
Removed:
Removed unnecessary information from the README file.
) in the left sidebar to display the table of contents.
