From a12594a009de8fdb096514441c8d99c41ebbb42c Mon Sep 17 00:00:00 2001 From: Aminda Suomalainen Date: Thu, 16 Mar 2023 19:53:28 +0200 Subject: [PATCH] add doctoc --- .pre-commit-config.yaml | 5 ++++ LaTeX/README.md | 12 ++++++++++ README.md | 8 +++++++ briar/README.md | 11 +++++++++ briar/forums/README.md | 8 +++++++ callforwarding/README.md | 11 +++++++++ fineid/README.md | 15 ++++++++++++ gayming/README.md | 14 +++++++++++ gayming/obs-studio/README.md | 11 +++++++++ git/README.md | 9 ++++++++ irc/anope/cstemplate.markdown | 8 +++++++ irc/chansetup/ergo.md | 9 ++++++++ irc/hexchat/configs.md | 10 ++++++++ irc/limnoria/hardening.md | 9 ++++++++ irc/limnoria/molly-guard-announce.md | 8 +++++++ irc/limnoria/mute-on-chan.md | 9 ++++++++ irc/limnoria/notice.md | 11 +++++++++ irc/limnoria/titlefetching.md | 13 +++++++++++ irc/matterbridge/README.md | 10 ++++++++ irc/matterbridge/myrelays.md | 18 +++++++++++++++ irc/palaver.md | 9 ++++++++ irc/weechat/colours.markdown | 9 ++++++++ irc/weechat/triggers.md | 9 ++++++++ laundry/programs.md | 8 +++++++ matrix/FluffyChat/quick-account-switching.md | 9 ++++++++ matrix/README.md | 10 ++++++++ .../im.vector.web.settings/README.md | 8 +++++++ matrix/m.room.join_rules/README.md | 12 ++++++++++ matrix/m.room.power_levels/README.md | 12 ++++++++++ matrix/m.room.server_acl/README.md | 9 ++++++++ matrix/m.room.tombstone/README.md | 9 ++++++++ .../README.md | 8 +++++++ matrix/retention/README.md | 9 ++++++++ pwa/README.md | 23 +++++++++++++++++++ wifi/README.md | 9 ++++++++ 35 files changed, 362 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index db2d662..fc1063d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,3 +19,8 @@ repos: hooks: - id: editorconfig-checker alias: ec +repos: +- repo: https://github.com/thlorenz/doctoc + rev: v2.2.0 + hooks: + - id: doctoc diff --git a/LaTeX/README.md b/LaTeX/README.md index 80aa132..eb39506 100644 --- a/LaTeX/README.md +++ b/LaTeX/README.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Notes on using LaTeX](#notes-on-using-latex) + - [Simple boilerplate](#simple-boilerplate) + - [Package management](#package-management) + - [Installing custom templates](#installing-custom-templates) + - [Noteworthy templates](#noteworthy-templates) + + + # Notes on using LaTeX To possibly save your self from headache: diff --git a/README.md b/README.md index 9e5f9dc..4fec530 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [LICENSING](#licensing) + + + This repository is a random assortment of files. In the beginning, I had some of them at gist.github.com, but as it doesn't provide any way for me to sort files, a separate repository is easier to handle. diff --git a/briar/README.md b/briar/README.md index 3e4c443..37d102b 100644 --- a/briar/README.md +++ b/briar/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Briar notes](#briar-notes) + - [Naming](#naming) + - [Briar desktop](#briar-desktop) + - [Further reading and quotes](#further-reading-and-quotes) + + + # Briar notes Briar is a P2P over Tor messenger that can also peer over LAN and Bluetooth. diff --git a/briar/forums/README.md b/briar/forums/README.md index f169549..309b1f4 100644 --- a/briar/forums/README.md +++ b/briar/forums/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Lists of Briar forums](#lists-of-briar-forums) + + + # Lists of Briar forums Briar Forums are groups where anyone can add anyone. They have no further diff --git a/callforwarding/README.md b/callforwarding/README.md index f451c5d..92184a2 100644 --- a/callforwarding/README.md +++ b/callforwarding/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Call forwarding, relevant commands edition](#call-forwarding-relevant-commands-edition) + - [Commands](#commands) + - [Status check](#status-check) + - [GUI](#gui) + + + # Call forwarding, relevant commands edition _This is widely documented around the internet, but everything has a lot diff --git a/fineid/README.md b/fineid/README.md index 6cd5c29..68abcea 100644 --- a/fineid/README.md +++ b/fineid/README.md @@ -1,3 +1,18 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Finnish Electronic Identity](#finnish-electronic-identity) + - [Requirements for everything](#requirements-for-everything) + - [Chromium](#chromium) + - [Firefox and Thunderbird](#firefox-and-thunderbird) + - [Okular](#okular) + - [Root certificates](#root-certificates) + - [Testing](#testing) + - [FINEID as SSH key](#fineid-as-ssh-key) + + + # Finnish Electronic Identity Finnish identity cards have been electronic for ages and as I tend to forget diff --git a/gayming/README.md b/gayming/README.md index 2321416..74dc6d5 100644 --- a/gayming/README.md +++ b/gayming/README.md @@ -1,3 +1,17 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Notes related to gaming](#notes-related-to-gaming) + - [Wayland / Sway](#wayland--sway) + - [Issues and solutions](#issues-and-solutions) + - [Constant camera rotation](#constant-camera-rotation) + - [Cursor doesn't stick to game window](#cursor-doesnt-stick-to-game-window) + - [Graphics corruption such as display full of black dots](#graphics-corruption-such-as-display-full-of-black-dots) + - [Steam client itself is laggy](#steam-client-itself-is-laggy) + + + # Notes related to gaming A lot of older files that I haven't touched recently were moved to this diff --git a/gayming/obs-studio/README.md b/gayming/obs-studio/README.md index b77faf6..b91db78 100644 --- a/gayming/obs-studio/README.md +++ b/gayming/obs-studio/README.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [My notes on using OBS Studio.](#my-notes-on-using-obs-studio) + - [resolution & bitrate](#resolution--bitrate) + - [Suggestions](#suggestions) + - [External links](#external-links) + + + # My notes on using OBS Studio. I have mostly understood how to add sources on OBS Studio, but I needed diff --git a/git/README.md b/git/README.md index 0c4032a..0b5e0f2 100644 --- a/git/README.md +++ b/git/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Random git files](#random-git-files) + - [Tracking GitHub pull requests with `git`](#tracking-github-pull-requests-with-git) + + + # Random git files - `gitignore` - `.gitignore` templates I may or may not use diff --git a/irc/anope/cstemplate.markdown b/irc/anope/cstemplate.markdown index b73f4db..8176012 100644 --- a/irc/anope/cstemplate.markdown +++ b/irc/anope/cstemplate.markdown @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [XOP](#xop) + + + **UNMAINTAINED, PLEASE READ https://mikaela.info/english/2015/03/12/stay-away-from-anope.html** This is unlike the Atheme cstemplate as Anope doesn't have similar template diff --git a/irc/chansetup/ergo.md b/irc/chansetup/ergo.md index 2c94ffe..9a77e16 100644 --- a/irc/chansetup/ergo.md +++ b/irc/chansetup/ergo.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Channel setup on Ergo](#channel-setup-on-ergo) + - [Private extras](#private-extras) + + + # Channel setup on Ergo ``` diff --git a/irc/hexchat/configs.md b/irc/hexchat/configs.md index 51efc99..a264a26 100644 --- a/irc/hexchat/configs.md +++ b/irc/hexchat/configs.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [HexChat configs](#hexchat-configs) + - [Settings changes](#settings-changes) + - [Settings → Text events](#settings-%E2%86%92-text-events) + + + # HexChat configs - Timestamp format: `[%Y-%j %H.%M.%S]` or `[%G-W%V-%u %H:%M:%S]` diff --git a/irc/limnoria/hardening.md b/irc/limnoria/hardening.md index 51d2edf..5822d91 100644 --- a/irc/limnoria/hardening.md +++ b/irc/limnoria/hardening.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Hardening Limnoria](#hardening-limnoria) + - [Passwordless users](#passwordless-users) + + + # Hardening Limnoria - Upstream documentation: https://docs.limnoria.net/use/security.html diff --git a/irc/limnoria/molly-guard-announce.md b/irc/limnoria/molly-guard-announce.md index ab9feca..b3e19d6 100644 --- a/irc/limnoria/molly-guard-announce.md +++ b/irc/limnoria/molly-guard-announce.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Preventing accidental owner announces](#preventing-accidental-owner-announces) + + + # Preventing accidental owner announces By default `announce` command sends a message to every channel the bot is on diff --git a/irc/limnoria/mute-on-chan.md b/irc/limnoria/mute-on-chan.md index 915a02f..9d10345 100644 --- a/irc/limnoria/mute-on-chan.md +++ b/irc/limnoria/mute-on-chan.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Muting on channel](#muting-on-channel) + - [Reverting](#reverting) + + + # Muting on channel There is `channel lobotomy add []`, but it may have unexpected diff --git a/irc/limnoria/notice.md b/irc/limnoria/notice.md index 522e5c6..3f0a48a 100644 --- a/irc/limnoria/notice.md +++ b/irc/limnoria/notice.md @@ -1,3 +1,14 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Using NOTICEs instead of PRIVMSGs](#using-notices-instead-of-privmsgs) + - [Other options](#other-options) + - [Other plugins](#other-plugins) + - [Reverting](#reverting) + + + # Using NOTICEs instead of PRIVMSGs Like https://tools.ietf.org/html/rfc1459#section-4.4.2 & https://tools.ietf.org/html/rfc2812#section-3.3.2 say should be used. diff --git a/irc/limnoria/titlefetching.md b/irc/limnoria/titlefetching.md index 03de4b2..9c62c22 100644 --- a/irc/limnoria/titlefetching.md +++ b/irc/limnoria/titlefetching.md @@ -1,3 +1,16 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [A bit opinionated titlefetching](#a-bit-opinionated-titlefetching) + - [Preparation](#preparation) + - [Actually enabling it](#actually-enabling-it) + - [Excluding domains from titlefetching](#excluding-domains-from-titlefetching) + - [Titlesnarfing ignored users](#titlesnarfing-ignored-users) + - [Bonus: Fediverse](#bonus-fediverse) + + + # A bit opinionated titlefetching ## Preparation diff --git a/irc/matterbridge/README.md b/irc/matterbridge/README.md index 14815c7..6cf257e 100644 --- a/irc/matterbridge/README.md +++ b/irc/matterbridge/README.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Matterbridge resources](#matterbridge-resources) + - [My other resources](#my-other-resources) + - [Other resources](#other-resources) + + + # Matterbridge resources Mainly _myrelays.md_ documenting what my personal matterbridge instance is diff --git a/irc/matterbridge/myrelays.md b/irc/matterbridge/myrelays.md index 98350e1..b374154 100644 --- a/irc/matterbridge/myrelays.md +++ b/irc/matterbridge/myrelays.md @@ -1,3 +1,21 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Matterbridging list](#matterbridging-list) + - [Definitions](#definitions) + - [Gateways](#gateways) + - [Mikaela.info](#mikaelainfo) + - [Tanukis (or "Pillow Fortress")](#tanukis-or-pillow-fortress) + - [ABGILPQT+](#abgilpqt) + - [Test](#test) + - [Antikupla](#antikupla) + - [Syötteet](#sy%C3%B6tteet) + - [cz-feed](#cz-feed) + - [borni](#borni) + + + # Matterbridging list This is a list of Matterbridge gateways that I am maintaining or those of diff --git a/irc/palaver.md b/irc/palaver.md index c40ab1b..9379f44 100644 --- a/irc/palaver.md +++ b/irc/palaver.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Palaver configs](#palaver-configs) + - [Other timestamp formats](#other-timestamp-formats) + + + # Palaver configs Upstream: https://palaverapp.com/guides/commands/set.html diff --git a/irc/weechat/colours.markdown b/irc/weechat/colours.markdown index d1a0c68..4b8d6b6 100644 --- a/irc/weechat/colours.markdown +++ b/irc/weechat/colours.markdown @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [WeeChat colours for dark background](#weechat-colours-for-dark-background) +- [Making colors look good with solarized terminals](#making-colors-look-good-with-solarized-terminals) + + + I use `/set irc.look.nick_color_hash djb2` (_"hash algorithm used to find the color for a nick: djb2 = variant of djb2 (position of letters matters: anagrams of a nick have different color), sum = sum of letters"_) diff --git a/irc/weechat/triggers.md b/irc/weechat/triggers.md index 16689c0..43278f0 100644 --- a/irc/weechat/triggers.md +++ b/irc/weechat/triggers.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [WeeChat Triggers](#weechat-triggers) + - [msgid visibility](#msgid-visibility) + + + # WeeChat Triggers - [WeeChat Trigger plugin documentation](https://weechat.org/files/doc/stable/weechat_user.en.html#trigger) diff --git a/laundry/programs.md b/laundry/programs.md index c973607..cceb6f8 100644 --- a/laundry/programs.md +++ b/laundry/programs.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Laundry machine programs](#laundry-machine-programs) + + + # Laundry machine programs I never remember these and then I take ages to find my notes, so in hopes diff --git a/matrix/FluffyChat/quick-account-switching.md b/matrix/FluffyChat/quick-account-switching.md index 06bd36d..cce7e25 100644 --- a/matrix/FluffyChat/quick-account-switching.md +++ b/matrix/FluffyChat/quick-account-switching.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Quick account switching in FluffyChat](#quick-account-switching-in-fluffychat) + - [Appendix: example `im.fluffychat.account_bundles` account event](#appendix-example-imfluffychataccount_bundles-account-event) + + + # Quick account switching in FluffyChat FluffyChat 0.41.0 brings support for using multiple accounts and has an early diff --git a/matrix/README.md b/matrix/README.md index 5fc0956..3ab2599 100644 --- a/matrix/README.md +++ b/matrix/README.md @@ -1,3 +1,13 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Notes regarding Matrix, a decentralised conversation store](#notes-regarding-matrix-a-decentralised-conversation-store) + - [Other notes not needing their own directories](#other-notes-not-needing-their-own-directories) + - [Account migration](#account-migration) + + + # Notes regarding Matrix, a decentralised conversation store As a lot of things require playing around with `/devtools` and raw state diff --git a/matrix/account-data/im.vector.web.settings/README.md b/matrix/account-data/im.vector.web.settings/README.md index 89f1602..768f8a9 100644 --- a/matrix/account-data/im.vector.web.settings/README.md +++ b/matrix/account-data/im.vector.web.settings/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [im.vector.web.settings](#imvectorwebsettings) + + + # im.vector.web.settings The main point here is the `room_directory_servers` as this is a more pleasant way to copy it around than diff --git a/matrix/m.room.join_rules/README.md b/matrix/m.room.join_rules/README.md index 846cd5a..591e618 100644 --- a/matrix/m.room.join_rules/README.md +++ b/matrix/m.room.join_rules/README.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [m.room.join_rules](#mroomjoin_rules) + - [knocking](#knocking) + - [membership of another room](#membership-of-another-room) + - [merging knocking and membership of another room](#merging-knocking-and-membership-of-another-room) + - [Note to self](#note-to-self) + + + # m.room.join_rules Controls who can join the room. This is best to configure in room settings. diff --git a/matrix/m.room.power_levels/README.md b/matrix/m.room.power_levels/README.md index 33d2284..b7a03d0 100644 --- a/matrix/m.room.power_levels/README.md +++ b/matrix/m.room.power_levels/README.md @@ -1,3 +1,15 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Template power levels event for quick copy-pasting](#template-power-levels-event-for-quick-copy-pasting) + - [Completeish event](#completeish-event) + - [Reasonable version](#reasonable-version) + - [Medium version](#medium-version) + - [Paranoid version](#paranoid-version) + + + # Template power levels event for quick copy-pasting The main point I do this for is users `users` diff --git a/matrix/m.room.server_acl/README.md b/matrix/m.room.server_acl/README.md index 64b384c..844a6b2 100644 --- a/matrix/m.room.server_acl/README.md +++ b/matrix/m.room.server_acl/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [m.room.server_acl](#mroomserver_acl) + - [Allowlist](#allowlist) + + + # m.room.server_acl This event type controls which servers can access the room at all. Be very careful diff --git a/matrix/m.room.tombstone/README.md b/matrix/m.room.tombstone/README.md index bf0c75b..3be55cb 100644 --- a/matrix/m.room.tombstone/README.md +++ b/matrix/m.room.tombstone/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [On Matrix tombstones](#on-matrix-tombstones) + - [PL50 tombstoning](#pl50-tombstoning) + + + # On Matrix tombstones I am not putting the events here as I have [scripts for that separately](https://gitea.blesmrt.net/mikaela/scripts/src/branch/master/bash). diff --git a/matrix/org.matrix.appservice-irc.config/README.md b/matrix/org.matrix.appservice-irc.config/README.md index 3a1cdac..3a466f9 100644 --- a/matrix/org.matrix.appservice-irc.config/README.md +++ b/matrix/org.matrix.appservice-irc.config/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [`org.matrix.appservice-irc.config`](#orgmatrixappservice-ircconfig) + + + # `org.matrix.appservice-irc.config` Also known as IRC bridge configuration, [upstream documentation](https://github.com/matrix-org/matrix-appservice-irc/blob/develop/docs/room_configuration.md) diff --git a/matrix/retention/README.md b/matrix/retention/README.md index fcc2df5..e5636b3 100644 --- a/matrix/retention/README.md +++ b/matrix/retention/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Room history retention settings / state event `m.room.retention`](#room-history-retention-settings--state-event-mroomretention) + - [Notes](#notes) + + + # Room history retention settings / state event `m.room.retention` - https://brendan.abolivier.bzh/matrix-retention-policies/ diff --git a/pwa/README.md b/pwa/README.md index e3b36d7..e0ef582 100644 --- a/pwa/README.md +++ b/pwa/README.md @@ -1,3 +1,26 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Potentially useful progressive web apps](#potentially-useful-progressive-web-apps) + - [Events](#events) + - [Food](#food) + - [Instant messaging](#instant-messaging) + - [Matrix](#matrix) + - [Instant messaging](#instant-messaging-1) + - [Social media](#social-media) + - [Telegram](#telegram) + - [Misc](#misc) + - [Learning](#learning) + - [Localization](#localization) + - [Music](#music) + - [Shopping](#shopping) + - [Social media](#social-media-1) + - [Travel](#travel) + - [Not PWAs but still possibly useful for homescreens](#not-pwas-but-still-possibly-useful-for-homescreens) + + + # Potentially useful progressive web apps Method for distinguishing PWAs from normal websites: adding them to diff --git a/wifi/README.md b/wifi/README.md index 42411bc..e5fa298 100644 --- a/wifi/README.md +++ b/wifi/README.md @@ -1,3 +1,12 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Requirements for WiFi devices](#requirements-for-wifi-devices) + - [See also](#see-also) + + + # Requirements for WiFi devices I am considering getting a 5G (mobile network) capable one, but as none