Merge pull request #227 from 8398a7/issue/224

[#224] migrate hugo
8398a7 · Sep 26, 2022 · 71975f3 · 71975f3
2 parents e59743d + 2676520
commit 71975f3
Show file tree

Hide file tree

Showing 76 changed files with 218 additions and 63,073 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs/themes/hugo-theme-relearn"]
+	path = docs/themes/hugo-theme-relearn
+	url = https://github.com/McShelby/hugo-theme-relearn.git
diff --git a/docs/.dockerignore b/docs/.dockerignore
diff --git a/docs/.editorconfig b/docs/.editorconfig
diff --git a/docs/.eslintrc.json b/docs/.eslintrc.json
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/.hugo_build.lock b/docs/.hugo_build.lock
diff --git a/docs/.prettierrc b/docs/.prettierrc
diff --git a/docs/Dockerfile b/docs/Dockerfile
diff --git a/docs/LICENSE b/docs/LICENSE
diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md
@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+
diff --git a/docs/config.js b/docs/config.js
diff --git a/docs/config.toml b/docs/config.toml
@@ -0,0 +1,95 @@
+theme = "hugo-theme-relearn"
+baseURL = "https://action-slack.netlify.app/"
+languageCode = "en-us"
+title = "action-slack"
+
+[outputs]
+home = ["HTML", "RSS", "JSON"]
+
+[params]
+  # This controls whether submenus will be expanded (true), or collapsed (false) in the
+  # menu; if no setting is given, the first menu level is set to false, all others to true;
+  # this can be overridden in the pages frontmatter
+  alwaysopen = true
+  # Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
+  # Useful to give opportunity to people to create merge request for your doc.
+  # See the config.toml file from this documentation site to have an example.
+  editURL = "https://github.com/8398a7/action-slack/edit/main/docs/content"
+  # Author of the site, will be used in meta information
+  author = "839 <8398a7@github.com>"
+  # Description of the site, will be used in meta information
+  description = ""
+  # Shows a checkmark for visited pages on the menu
+  showVisitedLinks = false
+  # Disable search function. It will hide search bar
+  disableSearch = false
+  # Disable search in hidden pages, otherwise they will be shown in search box
+  disableSearchHiddenPages = false
+  # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
+  disableSeoHiddenPages = false
+  # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
+  disableTagHiddenPages = false
+  # Javascript and CSS cache are automatically busted when new version of site is generated.
+  # Set this to true to disable this behavior (some proxies don't handle well this optimization)
+  disableAssetsBusting = false
+  # Set this to true to disable copy-to-clipboard button for inline code.
+  disableInlineCopyToClipBoard = false
+  # A title for shortcuts in menu is set by default. Set this to true to disable it.
+  disableShortcutsTitle = false
+  # If set to false, a Home button will appear below the search bar on the menu.
+  # It is redirecting to the landing page of the current language if specified. (Default is "/")
+  disableLandingPageButton = false
+  # When using mulitlingual website, disable the switch language button.
+  disableLanguageSwitchingButton = false
+  # Hide breadcrumbs in the header and only show the current page title
+  disableBreadcrumb = false
+  # If set to true, hide table of contents menu in the header of all pages
+  disableToc = false
+  # If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
+  disableMathJax = false
+  # Specifies the remote location of the MathJax js
+  customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
+  # Initialization parameter for MathJax, see MathJax documentation
+  mathJaxInitialize = "{}"
+  # If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
+  disableMermaid = false
+  # Specifies the remote location of the Mermaid js
+  customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
+  # Initialization parameter for Mermaid, see Mermaid documentation
+  mermaidInitialize = "{ \"theme\": \"default\" }"
+  # If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
+  disableSwagger = true
+  # Specifies the remote location of the RapiDoc js
+  customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
+  # Initialization parameter for Swagger, see RapiDoc documentation
+  swaggerInitialize = "{ \"theme\": \"light\" }"
+  # Hide Next and Previous page buttons normally displayed full height beside content
+  disableNextPrev = false
+  # Order sections in menu by "weight" or "title". Default to "weight";
+  # this can be overridden in the pages frontmatter
+  ordersectionsby = "weight"
+  # Change default color scheme with a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].
+  themeVariant = ["blue"]
+  # Change the title separator. Default to "::".
+  titleSeparator = "-"
+  # If set to true, the menu in the sidebar will be displayed in a collapsible tree view.
+  collapsibleMenu = false
+  # If a single page can contain content in multiple languages, add those here
+  additionalContentLanguage = ["en"]
+
+[Languages]
+  [[Languages.en.menu.shortcuts]]
+    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
+    identifier = "ds"
+    url = "https://github.com/8398a7/action-slack"
+    weight = 10
+
+[markup]
+  [markup.highlight]
+    # if set to `guessSyntax = true`, there will be no unstyled code even if no language
+    # was given BUT mermaid code fences will not work anymore! So this is a mandatory
+    # setting for your site
+    guessSyntax = false
+
+    # choose a color theme or create your own
+    style = "monokai"
diff --git a/docs/content/index.md → docs/content/_index.md b/docs/content/index.md → docs/content/_index.md
@@ -1,17 +1,13 @@
 ---
 title: action-slack
-metaTitle: action-slack
-metaDescription: You can notify slack of GitHub Actions.
 ---
 
-![](https://github.com/8398a7/action-slack/workflows/build-test/badge.svg)
-![](https://github.com/8398a7/action-slack/workflows/Slack%20Mainline/badge.svg)
-![](https://img.shields.io/github/license/8398a7/action-slack?color=brightgreen)
-![](https://img.shields.io/github/v/release/8398a7/action-slack?color=brightgreen)
-[![codecov](https://codecov.io/gh/8398a7/action-slack/branch/master/graph/badge.svg)](https://codecov.io/gh/8398a7/action-slack)
+## action-slack
 
 You can notify slack of GitHub Actions.
 
+![success](https://user-images.githubusercontent.com/8043276/185978284-4c2c5683-5d0d-4a8e-a0f8-1e74c2c8d1fa.png)
+
 - [Usage](/usage)
 - [v2 Document Link](https://github.com/8398a7/action-slack/blob/v2/README.md)
 
@@ -26,4 +22,9 @@ steps:
     if: always() # Pick up events even if the job fails or is canceled.
 ```
 
-<img width="495" alt="success" src="https://user-images.githubusercontent.com/8043276/84587112-64844800-ae57-11ea-8007-7ce83a91dae3.png" />
+
+![](https://github.com/8398a7/action-slack/workflows/build-test/badge.svg)
+![](https://github.com/8398a7/action-slack/workflows/Slack%20Mainline/badge.svg)
+![](https://img.shields.io/github/license/8398a7/action-slack?color=brightgreen)
+![](https://img.shields.io/github/v/release/8398a7/action-slack?color=brightgreen)
+[![codecov](https://codecov.io/gh/8398a7/action-slack/branch/master/graph/badge.svg)](https://codecov.io/gh/8398a7/action-slack)
diff --git a/docs/content/contributors.md → docs/content/contributors/_index.md b/docs/content/contributors.md → docs/content/contributors/_index.md
@@ -1,7 +1,5 @@
 ---
 title: Contributors
-metaTitle: Contributors | action-slack
-metaDescription: This describes how to contribute to action-slack.
 ---
 
 ### Checkin

diff --git a/docs/content/migration.md b/docs/content/migration.md
diff --git a/docs/content/migration/01-migrate-from-v2-to-v3.md b/docs/content/migration/01-migrate-from-v2-to-v3.md
@@ -1,10 +1,8 @@
 ---
 title: migrate from v2 to v3
-metaTitle: migrate from v2 to v3 | action-slack
-metaDescription: This is a guide to help you transition from v2 to v3.
 ---
 
-# Fields in the slack will be selective.
+## Fields in the slack will be selective.
 
 In v2, the fields were automatically selected.
 
@@ -32,7 +30,7 @@ steps:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
 ```
 
-# Overwriting text
+## Overwriting text
 
 Until v2, a fixed statement (success/failure/cancel) was inserted for each status.  
 This means that even if the user specifies `text`, a fixed sentence is given at the beginning.
@@ -41,7 +39,7 @@ From v3, if text is specified, it will remove the fixed sentence and completely
 For example, in v2, ":white_check_mark: Succeeded GitHub Actions" was fixed on a successful job.  
 If a user wants to change :white_check_mark: to a different emoji, it will still be fixed, but from v3 it will be completely overwritten, which eliminates this problem.
 
-# Change the way Mentions are set up
+## Change the way Mentions are set up
 
 In v2, there are two features for Mentions.
 
@@ -56,7 +54,7 @@ This change is intended to consolidate the roles, as the existing method of ment
 `if_mention` specifies the state to fire, and `mention` specifies the target partner.  
 See [With Parameters](/with) for the other states that can be specified by `if_mention`.
 
-## Migrate mention
+### Migrate mention
 
 If you have set the following in v2
 
@@ -84,7 +82,7 @@ steps:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
 ```
 
-## Migrate only_mention_fail
+### Migrate only_mention_fail
 
 If you have set the following in v2
 
@@ -112,7 +110,7 @@ steps:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
 ```
 
-# Abolition of payload
+## Abolition of payload
 
 `payload` has been changed to `custom_payload`.  
 The `payload` will change to have a reserved word role in GitHub Actions.

diff --git a/docs/content/migration/_index.md b/docs/content/migration/_index.md
@@ -0,0 +1,4 @@
+---
+title: Migration
+weight: 3
+---