Add a paltry amount of documentation. So little.

This commit is contained in:
TakeV 2023-02-05 03:10:42 -08:00
parent be0214793e
commit 502fce5cee
Signed by: TakeV
GPG Key ID: A64F41345C7400AF
1 changed files with 17 additions and 10 deletions

View File

@ -6,8 +6,6 @@
#+TAGS: layer|web service #+TAGS: layer|web service
# The maximum height of the logo should be 200 pixels. # The maximum height of the logo should be 200 pixels.
[[img/mastodon.png]]
# TOC links should be GitHub style anchors. # TOC links should be GitHub style anchors.
* Table of Contents :TOC_4_gh:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]] - [[#description][Description]]
@ -16,24 +14,33 @@
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
* Description * Description
This layer adds support for something. This layer adds support for the [[https://codeberg.org/martianh/mastodon.el][emacs mastodon.el package]].
** Features: ** Features:
- Autocomplete - Use the mastodon.el package in spaaaacemacs
- Lint - Provides keybindings for some things!
- Refactor - Posts? You like posts? This will let you be one of the posts of all time.
- ...
* Install * Install
Download this repo into the =private= folder in your =.emacs.d= folder.
To use this configuration layer, add it to your =~/.spacemacs=. You will need to To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =mastodon= to the existing =dotspacemacs-configuration-layers= list in this add =mastodon= to the existing =dotspacemacs-configuration-layers= list in this
file. file.
* Key bindings * Key bindings
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------| |-------------+------------------------------|
| ~SPC x x x~ | Does thing01 | | ~SPC m f~ | Favorite a post |
| ~SPC m b~ | Boost a post |
| ~SPC m t~ | Create a new post |
| ~SPC m r~ | Reply to a post |
| ~SPC m g l~ | Go to your local timeline |
| ~SPC m g n~ | Get your notifications |
| ~SPC m g h~ | Go to your home timeline |
| ~SPC m g f~ | Go to the federated timeline |
| ~SPC m g p~ | Go to your profile |
# Use GitHub URLs if you wish to link a Spacemacs documentation file or its heading. # Use GitHub URLs if you wish to link a Spacemacs documentation file or its heading.
# Examples: # Examples: