Merge pull request #1 from egabancho/initial-content

Initial content from @egabancho

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run:  cp README.md docs/index.md
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+
+docs/index.md
+site/
+
+.venv
+.envrc
+.tools-versions

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Your contributions are always welcome!
+
+## Guidelines
+
+* Add one link per Pull Request.
+    * Make sure the PR title is in the format of `Add project-name`.
+    * Write down the reason why it is awesome.
+* Add the link: `* [project-name](http://example.com/) - A short description ends with a period.`
+    * Keep descriptions concise and **short**.
+* Add a section if needed.
+    * Add the section description.
+    * Add the section title to Table of Contents.
+* Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate.
+* Check your spelling and grammar.
+* Remove any trailing whitespace.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Esteban J. G. Gabancho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs.yml

@@ -0,0 +1,22 @@
+site_name: Awesome Invenio
+site_url: https://awesome-invenio.com
+site_description: An opinionated list of awesome Invenio extensions, overlays and resources.
+site_author: Esteban J. G. Gabancho
+repo_name: egabancho/awesome-invenio
+repo_url: https://github.com/egabancho/awesome-invenio
+theme:
+  name: material
+  palette:
+    primary: blue
+    accent: pink
+markdown_extensions:
+  - toc:
+      permalink: true
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/egabanho
+    - icon: fontawesome/brands/mastodon 
+      link: https://fosstodon.org/@egabancho
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/egabancho

scripts/bootstrap

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+script_path=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+echo $script_path
+
+pip install mkdocs-material
+ln -sf $script_path/../README.md $script_path/../docs/index.md

scripts/server

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+mkdocs serve