diff options
author | David Mehren | 2020-07-10 19:59:32 +0200 |
---|---|---|
committer | GitHub | 2020-07-10 19:59:32 +0200 |
commit | 3db8b0df43b027d15d13047e25617266ddc57f13 (patch) | |
tree | da64f90f7cd4ab4c1deaf67a572a45c2a583dc7e /docs/guides/auth/github.md | |
parent | 0b7dbd1f43899b4321ddf41bf98a64a7bd5fa48d (diff) | |
parent | 89895cef2e5785134bf1fdcc9c8813831c07f17b (diff) |
Merge pull request #410 from oupala/feature/markdown-linting
Diffstat (limited to '')
-rw-r--r-- | docs/guides/auth/github.md | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index d16b486f..dc46f74c 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -1,10 +1,11 @@ -Authentication guide - GitHub -=== +# Authentication guide - GitHub -**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +*Note:* This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks! 1. Sign-in or sign-up for a GitHub account + 2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab + 3. Click on the **New OAuth App** button, to create a new OAuth App: ![create-oauth-app](../../images/auth/create-oauth-app.png) @@ -17,19 +18,20 @@ Authentication guide - GitHub ![application-page](../../images/auth/application-page.png) 6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables - * `config.json`: - ```js - { - "production": { - "github": { - "clientID": "3747d30eaccXXXXXXXXX", - "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX" - } + - `config.json`: + ```js + { + "production": { + "github": { + "clientID": "3747d30eaccXXXXXXXXX", + "clientSecret": "2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX" } } - ``` - * environment variables: - ```sh - CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX - CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX - ```` + } + ``` + + - environment variables: + ```sh + CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX + CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX + ```` |