docs(:os): update READMEs to new format
This commit is contained in:
parent
20cac97c08
commit
f6335befb4
3 changed files with 118 additions and 67 deletions
|
@ -1,36 +1,46 @@
|
|||
#+TITLE: os/macos
|
||||
#+DATE: February 19, 2017
|
||||
#+SINCE: v1.3
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::os macos][Issues]] ↖ [[doom-module-source:os/macos][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :os macos
|
||||
#+SUBTITLE: Compatibility for our favorite walled garden
|
||||
#+CREATED: February 19, 2017
|
||||
#+SINCE: 1.3
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#features][Features]]
|
||||
- [[#open-with-x]["Open with X"]]
|
||||
|
||||
* Description
|
||||
* Description :unfold:
|
||||
This module provides extra functionality for macOS.
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/emacsorphanage/osx-trash][osx-trash]]
|
||||
+ [[https://github.com/purcell/ns-auto-titlebar][ns-auto-titlebar]]
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][ns-auto-titlebar]]
|
||||
- [[doom-package:][osx-trash]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires a macOS environment.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Features
|
||||
** "Open with X"
|
||||
This module adds various macOS-specific launchers under the =SPC o= prefix (=C-c
|
||||
o= for users with Evil disabled).
|
||||
This module adds various macOS-specific launchers under the [[kbd:][SPC o]] prefix ([[kbd:][C-c
|
||||
o]] for users with Evil disabled).
|
||||
|
||||
It also enables Keychain integration for =auth-source=. This is used by our [[file:../../../modules/app/irc/README.org][irc]]
|
||||
and [[file:../../../modules/tools/magit/README.org][magit]]-forge modules, for instance.
|
||||
It also enables Keychain integration for [[doom-package:][auth-source]]. This is used by our [[doom-module:][:app
|
||||
irc]] and [[doom-module:][:tools magit]] modules, for instance.
|
||||
|
||||
To support GitHub Forge add an internet password like this to your keychain:
|
||||
| Field | Value |
|
||||
|
@ -40,3 +50,19 @@ To support GitHub Forge add an internet password like this to your keychain:
|
|||
| Account | <username>^forge |
|
||||
| Where | https://api.github.com/ |
|
||||
| Password | <token> |
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue