Merge pull request #117 from input-output-hk/jospald/ADP-635/cardano-rest-migration-guide

[WIP] Cardano rest migration guide

Author: KtorZ

migration-guide/Makefile

@@ -0,0 +1,6 @@
+default: site
+
+site: mkdocs.yml src/explorer-api.md src/index.md src/submit-api.md
+	@mkdocs build
+
+.PHONY: site

migration-guide/README.md

@@ -0,0 +1,13 @@
+# cardano-rest migration guide
+
+## Installing Dependencies
+
+```console
+$ pip install -r requirements.txt
+```
+
+## Building Sources
+
+```console
+$ make 
+```

migration-guide/mkdocs.yml

@@ -0,0 +1,40 @@
+site_name: cardano-rest Migration Guide
+site_url: https://input-output-hk.github.io/cardano-rest/migration-guide/
+repo_url: https://github.com/input-output-hk/cardano-rest
+edit_uri: tree/master/migration-guide/src
+site_description: A migration guide to help moving away from cardano-rest to other more sensible solutions after deprecation.
+copyright: |
+  Copyright © 2020 - present | Input Output
+docs_dir: src
+theme:
+  name: material
+  language: en
+  palette:
+    primary: deep-purple
+    accent: deep-purple
+  include_search_page: false
+  search_index_only: true
+  nav:
+    - Getting Started: index.md
+    - explorer-api: cardano-api.md
+    - submmit-api: submit-api.md
+
+markdown_extensions:
+  - markdown.extensions.admonition
+  - markdown.extensions.codehilite:
+      guess_lang: false
+  - markdown.extensions.toc:
+      permalink: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - admonition

migration-guide/requirements.txt

@@ -0,0 +1 @@
+mkdocs-material>=3.0