wip

README.md

@@ -34,8 +34,16 @@ $ make serve      # run local web server with hot reload feature
 
 If the commands above were run with successful, the web content will be accessible: http://127.0.0.1:8000/
 
-## Configure the GitHub Action permissions
+## Manual Configurations
+
+### 1. Configure the GitHub Action permissions
 
 The [./template-gh-pages-mkdocs/.github/workflows/deploy-contents-to-github-pages.yml](.github/workflows/deploy-contents-to-github-pages.yml) use the `${{ secrets.GITHUB_TOKEN }}` variable to perform the push of the `gh-pages` branch. For this, it is necessary configure the Read Write permission for GitHub action. Check the following print to configure it.
 
 ![](./.img/how-to-configure-git-actions.png)
+
+### 2. Replace the `mkdocs.yml`
+
+Replace the all variables that had `>>> REPLACE THE VALUE` in the [./mkdocs.yml](./mkdocs.yml) with values based on your repo.
+
+![](./.img/how-to-configure-git-actions.png)

mkdocs.yml

@@ -1,11 +1,25 @@
+# >>> REPLACE THE VALUE
 site_name: template-gh-pages-mkdocs
+
+# >>> REPLACE THE VALUE
 site_url: https://github.com/augustoliks/template-gh-pages-mkdocs
-site_description: AWS Concepts
+
+# >>> REPLACE THE VALUE
+site_description: template-gh-pages-mkdocs
+
+# >>> REPLACE THE VALUE
 site_author: Carlos Neto | @augustoliks
+
+# >>> REPLACE THE VALUE
 repo_name: augustoliks/template-gh-pages-mkdocs
+
+# >>> REPLACE THE VALUE
 repo_url: https://github.com/augustoliks/template-gh-pages-mkdocs
+
+# >>> REPLACE THE VALUE
 edit_uri: ''
 
+# >>> REPLACE THE VALUE
 nav:
   - template-gh-pages-mkdocs: index.md
   - 01. Page First: 01-page-first.md
@@ -35,10 +49,14 @@ theme:
     - navigation.top
 extra:
   social:
+
     - icon: fontawesome/brands/github-alt
-      link: PLACEHOLDER-YOUR-GITHUB-LINK
+      # >>> REPLACE THE VALUE
+      link: https://github.com/augustoliks
+
     - icon: fontawesome/brands/linkedin
-      link: PLACEHOLDER-YOUR-LINKEDIN-LINK
+      # >>> REPLACE THE VALUE
+      link: https://linkedin.com/in/c-neto
 
 markdown_extensions:
   - pymdownx.highlight