Adding basic mkdocs files

.ansible-lint

@@ -5,5 +5,6 @@ exclude_paths:
   - .cache/
   - ~/.cache/ansible-lint/
   - ~/.cache/ansible-compat/
+  - mkdocs.yml
 warn_list:
   - galaxy[version-incorrect]

.pre-commit-config.yaml

@@ -10,6 +10,7 @@ repos:
       - id: check-toml
       - id: check-json
       - id: check-yaml
+        args: ['--unsafe']
       - id: debug-statements
       - id: check-merge-conflict
       - id: pretty-format-json

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
+- Docs site.
+
 - MacOS Tools/Packages:
     * Ubuntu Nerd Font.
     * Ubuntu Mono Nerd Font.

LICENSE.rst → LICENSE.md

@@ -1,6 +1,5 @@
 
-MIT License
-===========
+# MIT License
 
 Copyright (c) 2022, Federico Jaureguialzo
 

README.md

@@ -1,6 +1,6 @@
 # Development Setup
 
-<div align="center">
+<div markdown="span" align="center">
 
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/fedejaure/dev-setup?logo=github)](https://github.com/fedejaure/dev-setup/releases)
 [![Tests](https://github.com/fedejaure/dev-setup/workflows/tests/badge.svg)](https://github.com/fedejaure/dev-setup/actions?workflow=tests)
@@ -78,9 +78,9 @@ My own Ansible collection for development setup (use by your own risk).
 * [pipenv](https://pipenv.pypa.io/en/latest/)
 * [cookiecutter](https://github.com/cookiecutter/cookiecutter)
 * [poetry](https://python-poetry.org/) with:
-  * [Poetry Plugin: Export](https://github.com/python-poetry/poetry-plugin-export)
+    - [Poetry Plugin: Export](https://github.com/python-poetry/poetry-plugin-export)
 * [nox](https://nox.thea.codes/en/stable/) with:
-  * [nox-poetry](https://nox-poetry.readthedocs.io/en/stable/)
+    - [nox-poetry](https://nox-poetry.readthedocs.io/en/stable/)
 
 #### Other installed Tools
 
@@ -100,10 +100,14 @@ My own Ansible collection for development setup (use by your own risk).
 
     Create a temporary virtualenv, activate the virtualenv and install ansible:
 
-    ```shell session
+    <!-- termynal -->
+
+    ```console
     $ /usr/bin/python3 -m venv .venv
     $ . .venv/bin/activate
     (.venv)$ pip3 install ansible
+    ---> 100%
+    Installed
     ```
 
 4. Install ansible requirements `ansible-galaxy install -r requirements.yml`.
@@ -112,11 +116,11 @@ My own Ansible collection for development setup (use by your own risk).
 
 6. Run `ansible-playbook playbooks/main.yml --ask-become-pass -i inventory`.
 
-> Note: You need to agree to Xcode's license.
->
-> ```shell session
-> $ sudo xcodebuild -license
-> ```
+    > Note: You need to agree to Xcode's license.
+    >
+    > ```console
+    > $ sudo xcodebuild -license
+    > ```
 
 ### Configuring a remote Mac
 
@@ -126,7 +130,9 @@ My own Ansible collection for development setup (use by your own risk).
 
 2. Install dependencies:
 
-    ```shell session
+    <!-- termynal -->
+
+    ```console
     $ poetry install --no-root
     Using python3.10 (3.10.8)
     Creating virtualenv .venv
@@ -139,7 +145,9 @@ My own Ansible collection for development setup (use by your own risk).
 
 3. Activate the virtual environment:
 
-    ```shell session
+    <!-- termynal -->
+
+    ```console
     $ poetry shell
     Using python3.10 (3.10.8)
     Spawning shell within .venv
@@ -148,8 +156,15 @@ My own Ansible collection for development setup (use by your own risk).
 
 4. Install required Ansible roles:
 
-    ```shell session
+    <!-- termynal -->
+
+    ```console
     (dev-setup)$ inv galaxy-install
+    Starting galaxy role install process
+    ...
+    Starting galaxy collection install process
+    ...
+    fedejaure.dev_setup was installed successfully
     ```
 
 5. Configure the `inventory` file:
@@ -178,20 +193,31 @@ My own Ansible collection for development setup (use by your own risk).
         >
         >   > You can also enable remote login on the command line:
         >   >
-        >   > ```shell session
+        >   > ```console
         >   > $ sudo systemsetup -setremotelogin on
         >   > ```
         >
         >   > Note: You need to agree to Xcode's license.
         >   >
-        >   > ```shell session
+        >   > ```console
         >   > $ sudo xcodebuild -license
         >   > ```
 
 6. Run the playbook:
 
-    ```shell session
+    <!-- termynal -->
+
+    ```console
     (dev-setup)$ inv playbook --ask-pass --ask-become-pass
+    SSH password:
+    BECOME password[defaults to SSH password]:
+
+    PLAY [Mac OSX Playbook] ***************************************************
+
+    TASK [Gathering Facts] ****************************************************
+    ok: [127.0.0.1]
+
+    ...
     ```
 
 7. Enjoy!
@@ -278,13 +304,16 @@ Development
 
 To display available tasks run:
 
-```shell session
+<!-- termynal -->
+
+```console
 (dev-setup)$ inv --list
 Available tasks:
 
   ansible-lint     Run ansible linter.
   clean            Run all clean sub-tasks.
   clean-python     Clean up python file artifacts.
+  docs             Build documentation.
   format           Format code.
   galaxy-install   Install ansible-galaxy requirements.
   hooks            Run pre-commit hooks.

docs/changelog.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to dev-setup
+
+My own Ansible collection for development setup (use by your own risk).

docs/license.md

@@ -0,0 +1 @@
+../LICENSE.md

docs/readme.md

@@ -0,0 +1 @@
+../README.md

mkdocs.yml

@@ -0,0 +1,134 @@
+---
+# Project information
+site_name: Development Setup
+site_url: https://fedejaure.github.io/dev-setup/
+site_author: Federico Jaureguialzo
+site_description: >-
+  My own Ansible collection for development setup.
+
+# Repository
+repo_name: fedejaure/dev-setup
+repo_url: https://github.com/fedejaure/dev-setup
+
+# Copyright
+copyright: "Copyright &copy; 2020 - <script>document.write(new Date().getFullYear())</script> Federico Jaureguialzo"
+
+# Configuration
+theme:
+  name: material
+  # custom_dir: docs/overrides
+  features:
+    - announce.dismiss
+    # - content.action.edit
+    # - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    # - content.code.select
+    # - content.footnote.tooltips
+    # - content.tabs.link
+    - content.tooltips
+    # - header.autohide
+    # - navigation.expand
+    - navigation.footer
+    - navigation.indexes
+    # - navigation.instant
+    # - navigation.instant.prefetch
+    # - navigation.instant.progress
+    # - navigation.prune
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # - toc.integrate
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/link
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: brown
+      accent: brown
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: brown
+      accent: black
+      toggle:
+        icon: material/toggle-switch-off
+        name: Switch to system preference
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon:
+    repo: fontawesome/brands/github-alt
+  # logo: img/icon-white.svg
+  # favicon: assets/favicon.png
+  # icon:
+  #   logo: logo
+
+# Plugins
+plugins:
+  - search:
+  - minify:
+      minify_html: true
+  - termynal:
+      prompt_literal_start:
+        - "$"
+        - "(.venv)$"
+        - "(dev-setup)$"
+
+# Hooks
+# hooks:
+
+# Additional configuration
+extra:
+  analytics:
+    provider: google
+    property: !ENV GOOGLE_ANALYTICS_KEY
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/fedejaure
+
+# Extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.mark
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tilde
+
+
+# Page tree
+nav:
+  - Home: index.md
+  - Getting started:
+    - Overview: readme.md
+    - License: license.md
+  - Changelog: changelog.md