From f0566f28dfb887a2617c32666a2b876f4d93c541 Mon Sep 17 00:00:00 2001 From: Aminda Suomalainen Date: Mon, 14 Apr 2025 10:23:58 +0300 Subject: [PATCH] fix toc generation especially for manual --- .pre-commit-config.yaml | 9 +++++++++ Manual.md | 38 +++++++++++++++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..1237eb7 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,9 @@ +ci: + autoupdate_schedule: quarterly + +repos: + - repo: https://github.com/thlorenz/doctoc + rev: v2.2.0 + hooks: + - id: doctoc + args: [--update-only, --title, '**Table of Contents**'] diff --git a/Manual.md b/Manual.md index 9483474..1d26b32 100644 --- a/Manual.md +++ b/Manual.md @@ -1,9 +1,45 @@ **This is WIP!** + + + + + **Table of Contents** -[TOC] +- [Basics](#basics) + - [Before being logged in](#before-being-logged-in) + - [How do I log in with username and password?](#how-do-i-log-in-with-username-and-password) + - [How do I log in with SSO (For example Mozilla or Element One)?](#how-do-i-log-in-with-sso-for-example-mozilla-or-element-one) + - [In the Room list](#in-the-room-list) + - [How do I start a new room?](#how-do-i-start-a-new-room) + - [How do I start a new direct message?](#how-do-i-start-a-new-direct-message) + - [How do I join an existing room?](#how-do-i-join-an-existing-room) + - [How do I join an existing room on another server?](#how-do-i-join-an-existing-room-on-another-server) + - [In a Room or Direct Message](#in-a-room-or-direct-message) + - [How do I change the title of a room I manage?](#how-do-i-change-the-title-of-a-room-i-manage) + - [How do I change the topic of a room I manage?](#how-do-i-change-the-topic-of-a-room-i-manage) + - [How do I change the permissions of a room I manage?](#how-do-i-change-the-permissions-of-a-room-i-manage) + - [In the User Profile](#in-the-user-profile) + - [How do I change my Display Name?](#how-do-i-change-my-display-name) + - [How do I change my Avatar?](#how-do-i-change-my-avatar) + - [In the Settings](#in-the-settings) + - [How do I change the Look of my Client?](#how-do-i-change-the-look-of-my-client) + - [Bug reporting basics](#bug-reporting-basics) +- [Intermediate](#intermediate) + - [Emotes](#emotes) + - [What are emotes?](#what-are-emotes) + - [Are Emotes the same as Sticker?](#are-emotes-the-same-as-sticker) + - [How do I use the Emotes setting?](#how-do-i-use-the-emotes-setting) + - [How do I use Emotes in chats?](#how-do-i-use-emotes-in-chats) + - [How do I use Emotes from others?](#how-do-i-use-emotes-from-others) + - [Bug Reporting with logs](#bug-reporting-with-logs) + + + + + # Basics ## Before being logged in