Skip to content

Commit

Permalink
docs(toc): generated table of contents using remark
Browse files Browse the repository at this point in the history
  • Loading branch information
travi committed Jan 12, 2024
1 parent 0298b0a commit 7fb4972
Show file tree
Hide file tree
Showing 5 changed files with 25,859 additions and 13,117 deletions.
3 changes: 3 additions & 0 deletions .remarkrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"plugins": ["@form8ion/remark-preset"]
}
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ This GitHub App syncs repository settings defined in `.github/settings.yml` to G

<!--status-badges end -->

## Table of Contents

* [Usage](#usage)
* [Install](#install)
* [Hosted GitHub.com App](#hosted-githubcom-app)
* [Self-Hosted App](#self-hosted-app)
* [Configuration](#configuration)
* [Security Implications](#security-implications)

## Usage

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

### Hosted GitHub.com App
#### Hosted GitHub.com App

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

Expand All @@ -26,7 +35,7 @@ entire organization.

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

### Self-Hosted App
#### Self-Hosted App

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

> [!Caution]
> Note that this app inherently _escalates anyone with `push`
permissions to the __admin__ role_, since they can push config settings to the
default branch, which will be synced.
Until then, use caution when merging PRs and adding collaborators.
> permissions to the __admin__ role_, since they can push config settings to the
> default branch, which will be synced.
> Use caution when merging PRs and adding collaborators.
One way to preserve admin/push permissions is to utilize the
[GitHub CodeOwners feature](https://help.github.com/articles/about-codeowners/)
Expand Down
12 changes: 12 additions & 0 deletions docs/self-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@

<!--consumer-badges end -->

## Table of Contents

* [Deploy a Self-Hosted Instance](#deploy-a-self-hosted-instance)
* [Install `@repository-settings/app` as a dependency of your own app (recommended)](#install-repository-settingsapp-as-a-dependency-of-your-own-app-recommended)
* [Depend on the package from npm](#depend-on-the-package-from-npm)
* [Example node.js app](#example-nodejs-app)
* [Deploy a fork of this repository](#deploy-a-fork-of-this-repository)
* [Permissions & events](#permissions--events)
* [Permissions](#permissions)
* [Organization Permissions](#organization-permissions)
* [Events](#events)

## Deploy a Self-Hosted Instance

Multiple options exist for deploying a self-hosted instance:
Expand Down

0 comments on commit 7fb4972

Please sign in to comment.