Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit 6eec961

Browse files
committed
🔄 synced local 'README.md' with remote 'docs/Template/configuration.md'
1 parent 20220c0 commit 6eec961

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ title: Configuration
99
- [Documentation](https://obsidian-publisher.netlify.app/)
1010
- [Github Discussion](https://github.com/ObsidianPublisher/obsidian-github-publisher/discussions)
1111

12+
## Repository configuration
13+
14+
Some actions needs a `GH_PAT` secret in your repository settings. This token should have the `repo` and `workflows` scope. You can create a token [here](https://github.com/settings/tokens/new?description=PUBLISHER%20TEMPLATE&scopes=repo,workflow).
15+
16+
[See here to know how to register it as a secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
17+
18+
You can get more information about workflows and tokens [here](https://obsidian-publisher.netlify.app/template/actions/).
19+
20+
> [!NOTE]
21+
> If you want to use the Advanced Vercel/Netlify Workflow, you needs to configure more secrets keys.
22+
> You can get [more information here](https://obsidian-publisher.netlify.app/template/advanced_workflow/).
23+
1224
## Mkdocs configuration
1325

1426
You need to configure the plugin and the `mkdocs` configuration for it to work properly.
@@ -19,7 +31,7 @@ In the repository that you cloned, you will find a `mkdocs.yml` file. This file
1931

2032
1. `site_name`
2133
2. `site_description`
22-
3. `site_url` (critical): By default, it's `https://github_username.github.io/repo_name`[^1]
34+
3. `site_url` (critical): By default, it's `https://github_username.io/repo_name`[^1]
2335

2436
To edit the logo and favicon, first put the chosen files in the `assets/logo` directory, and then change `logo` and `favicon`:
2537

0 commit comments

Comments
 (0)