Start a doc site

Author: oprypin

.eslintrc.json

@@ -4,6 +4,7 @@
         "es6": true,
         "node": true
     },
+    "ignorePatterns": ["site/"],
     "extends": "eslint:recommended",
     "globals": {
         "Atomics": "readonly",

.github/workflows/deploy-docs.yml

@@ -0,0 +1,26 @@
+name: Deploy docs
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 6 * * 6'
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v2
+      - name: Install Python
+        uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+      - name: Build site
+        run: mkdocs build
+        working-directory: docs
+      - name: Deploy to gh-pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: oprypin/push-to-gh-pages@v3
+        with:
+          publish_dir: site
+          commit_message: 'Generate docs: '

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 .vscode/
+site/

README.md

@@ -52,64 +52,64 @@ Alternatively, you can use the container-based approach [as in the starter workf
 
 ### Inputs
 
-* * **`crystal: 0.35.1`** (not supported on Windows)
+ *   *  **`crystal: 0.35.1`** (not supported on Windows)
 
-    Install a particular release of Crystal.
+        Install a particular release of Crystal.
 
-  * **`crystal: latest`** (default; not supported on Windows)
+     *  **`crystal: latest`** (default; not supported on Windows)
 
-    Install the latest released version of Crystal.
+        Install the latest released version of Crystal.
 
-  * **`crystal: nightly`** (default on Windows)
+     *  **`crystal: nightly`** (default on Windows)
 
-    Install Crystal from the latest continuous build on [crystal.git][] master.
+        Install Crystal from the latest continuous build on [crystal.git][] master.
 
-* * **`shards: true`** (default)
+ *   *  **`shards: true`** (default)
 
-    Ensure that *some* released version of [Shards][] is available.
-    This uses the build that's bundled with Crystal's releases. Other options are slower, as building Shards is a necessary step then.
+        Ensure that *some* released version of [Shards][] is available.
+        This uses the build that's bundled with Crystal's releases. Other options are slower, as building Shards is a necessary step then.
 
-  * **`shards: false`**
+     *  **`shards: false`**
 
-    Ensure that `shards` executable is *not* available.
+        Ensure that `shards` executable is *not* available.
 
-  * **`shards: latest`**
+     *  **`shards: latest`**
 
-    Build and install the latest released version of Shards.
+        Build and install the latest released version of Shards.
 
-  * **`shards: 0.13.0`**
+     *  **`shards: 0.13.0`**
 
-    Build and install a particular release of Shards.
+        Build and install a particular release of Shards.
 
-  * **`shards: nightly`**
+     *  **`shards: nightly`**
 
-    Build and install the latest commit of [shards.git][] master.
+        Build and install the latest commit of [shards.git][] master.
 
-* **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
+ *  **`arch: x86_64`**, **`arch: x86`** (defaults to current OS arch)
 
-  The architecture of the build of Crystal to download.
+    The architecture of the build of Crystal to download.
 
-* **`destination: some/path`**
+ *  **`destination: some/path`**
 
-  The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
+    The directory to store Crystal in, after extracting. Will directly affect `outputs.path` (the default is in a temporary location).
 
-* **`token: ${{ github.token }}`**
+ *  **`token: ${{ github.token }}`**
 
-  Personal access token (auto-populated).
+    Personal access token (auto-populated).
 
 ### Outputs
 
-* **`crystal`** (`${{ steps.some_step_id.outputs.crystal }}`)
+ *  **`crystal`** (`${{ steps.some_step_id.outputs.crystal }}`)
 
-  The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
+    The actual version of Crystal (as a ref in crystal-lang/[crystal.git][]) that was installed.
 
-* **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
+ *  **`shards`** (`${{ steps.some_step_id.outputs.shards }}`)
 
-  The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
+    The actual version of Shards (as a ref in crystal-lang/[shards.git][]) that was installed.
 
-* **`path`** (`${{ steps.some_step_id.outputs.path }}`)
+ *  **`path`** (`${{ steps.some_step_id.outputs.path }}`)
 
-  The path where Crystal was extracted to, so you can use '[path]/bin/crystal', '[path]/src' etc.
+    The path where Crystal was extracted to, so you can use '[path]/bin/crystal', '[path]/src' etc.
 
 [github action]: https://github.com/features/actions
 [crystal]: https://crystal-lang.org/

docs/README.md

@@ -0,0 +1 @@
+--8<-- "../README.md"

docs/mkdocs.yml

@@ -0,0 +1,31 @@
+site_name: install-crystal action
+site_url: "https://oprypin.github.io/install-crystal"
+repo_url: "https://github.com/oprypin/install-crystal"
+edit_uri: blob/master/docs/
+use_directory_urls: false
+docs_dir: .
+site_dir: ../site
+
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+  palette:
+    primary: teal
+    accent: purple
+
+plugins:
+  - search
+  - same-dir
+
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.magiclink
+  - pymdownx.superfences
+  - pymdownx.details
+  - pymdownx.snippets:
+      check_paths: true
+  - admonition
+  - def_list
+  - toc:
+      permalink: "#"

docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs
+mkdocs-material
+mkdocs-same-dir