Skip to content

Commit ca66154

Browse files
committed
docs(toc): generated table of contents using remark
1 parent 0298b0a commit ca66154

File tree

5 files changed

+25859
-13117
lines changed

5 files changed

+25859
-13117
lines changed

.remarkrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"plugins": ["@form8ion/remark-preset"]
3+
}

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ This GitHub App syncs repository settings defined in `.github/settings.yml` to G
99

1010
<!--status-badges end -->
1111

12+
## Table of Contents
13+
14+
* [Usage](#usage)
15+
* [Install](#install)
16+
* [Hosted GitHub.com App](#hosted-githubcom-app)
17+
* [Self-Hosted App](#self-hosted-app)
18+
* [Configuration](#configuration)
19+
* [Security Implications](#security-implications)
20+
1221
## Usage
1322

1423
### Install
@@ -17,7 +26,7 @@ To gain the benefits of the Repository Settings app, it will need to installed
1726
as a GitHub App on your repositories.
1827
First, choose which approach to using the Repository Settings App is most appropriate for you:
1928

20-
### Hosted GitHub.com App
29+
#### Hosted GitHub.com App
2130

2231
A hosted version is provided for use with GitHub.com.
2332

@@ -26,7 +35,7 @@ entire organization.
2635

2736
[![Powered by Vercel][vercel-badge]][vercel-link]
2837

29-
### Self-Hosted App
38+
#### Self-Hosted App
3039

3140
If you would prefer to self-host your own instance, see the documentation about
3241
[self-hosting](docs/self-host.md) if you would like to run your own instance of this app.
@@ -41,9 +50,9 @@ about updating your repository settings through pull-requests.
4150

4251
> [!Caution]
4352
> Note that this app inherently _escalates anyone with `push`
44-
permissions to the __admin__ role_, since they can push config settings to the
45-
default branch, which will be synced.
46-
Until then, use caution when merging PRs and adding collaborators.
53+
> permissions to the __admin__ role_, since they can push config settings to the
54+
> default branch, which will be synced.
55+
> Use caution when merging PRs and adding collaborators.
4756
4857
One way to preserve admin/push permissions is to utilize the
4958
[GitHub CodeOwners feature](https://help.github.com/articles/about-codeowners/)

docs/self-host.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66

77
<!--consumer-badges end -->
88

9+
## Table of Contents
10+
11+
* [Deploy a Self-Hosted Instance](#deploy-a-self-hosted-instance)
12+
* [Install `@repository-settings/app` as a dependency of your own app (recommended)](#install-repository-settingsapp-as-a-dependency-of-your-own-app-recommended)
13+
* [Depend on the package from npm](#depend-on-the-package-from-npm)
14+
* [Example node.js app](#example-nodejs-app)
15+
* [Deploy a fork of this repository](#deploy-a-fork-of-this-repository)
16+
* [Permissions & events](#permissions--events)
17+
* [Permissions](#permissions)
18+
* [Organization Permissions](#organization-permissions)
19+
* [Events](#events)
20+
921
## Deploy a Self-Hosted Instance
1022

1123
Multiple options exist for deploying a self-hosted instance:

0 commit comments

Comments
 (0)