amogus2/emacs-dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Cherti
2025-07-15 15:07:44 -04:00
parent 48d7ef686c
commit 4eb947f534
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -960,6 +960,19 @@ This configuration sets up `markdown-mode` with deferred loading to improve star
(markdown-toc-header-toc-title "**Table of Contents**")) (markdown-toc-header-toc-title "**Table of Contents**"))
``` ```
Once installed:
* To **insert a table of contents** for the first time, run:
`M-x markdown-toc-generate-toc`
* To **update an existing table of contents**, run:
`M-x markdown-toc-generate-or-refresh-toc`
* To **remove an existing table of contents**, run:
`M-x markdown-toc-delete-toc`
These commands work on any Markdown buffer and rely on properly formatted headers (e.g., `#`, `##`) to build the TOC.
The author also recommends reading the following article: [Emacs: Automating Table of Contents Update for Markdown Documents (e.g., README.md)](https://www.jamescherti.com/emacs-markdown-table-of-contents-update-before-save/). The author also recommends reading the following article: [Emacs: Automating Table of Contents Update for Markdown Documents (e.g., README.md)](https://www.jamescherti.com/emacs-markdown-table-of-contents-update-before-save/).
### Tree-sitter Integration (Better Syntax Highlighting) ### Tree-sitter Integration (Better Syntax Highlighting)