feat: Documentation and API reference (#348)

Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com> Co-authored-by: zakariasaad <zakaria.elas@gmail.com> Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com> Co-authored-by: Kasper <kasper@medusa-commerce.com> Co-authored-by: Sebastian Rindom <skrindom@gmail.com> Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2021-08-24 18:16:42 +02:00
parent 5d63b0c8d2
commit f76aa816a5
71 changed files with 16482 additions and 1156 deletions
--- a/www/docs/src/css/custom.css
+++ b/www/docs/src/css/custom.css
@@ -0,0 +1,190 @@
+/* stylelint-disable docusaurus/copyright-header */
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+@import url("https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;700&display=swap");
+
+:root {
+  /* Colors */
+  --ifm-color-primary: #0a3149;
+  --ifm-color-primary-dark: #0a3149;
+  --ifm-color-primary-darker: #0a3149;
+  --ifm-color-primary-darkest: #0a3149;
+  --ifm-color-primary-light: #0a3149;
+  --ifm-color-primary-lighter: #0a3149;
+  --ifm-color-primary-lightest: #0a3149;
+  --ifm-medusa-gray: #f0f0f0;
+
+  /* Fonts */
+  --ifm-code-font-size: 90%;
+  --ifm-font-family-base: "Open Sans";
+
+  /* Sidebar */
+  --doc-sidebar-width: 350px !important;
+
+  /* Docs Page */
+  --ifm-docs-page-max-width: 700px;
+
+  /* Toc */
+  --ifm-toc-border-color: #f0f0f0;
+  --ifm-toc-link-color: #a6acb5;
+  --ifm-toc-padding-horizontal: 9px;
+
+  /* Navbar */
+  --ifm-navbar-shadow: 0px 1px 0px 0px #a6acb5;
+}
+
+html[data-theme="dark"] {
+  --ifm-color-primary-dark: #ff4848;
+  --ifm-color-primary: #ff4242;
+  --ifm-background-color: #1f1f1f;
+  --ifm-background-surface-color: #1f1f1f;
+  --ifm-medusa-gray: #292929;
+  --ifm-menu-color: #fff;
+  --ifm-toc-border-color: #333;
+}
+
+/* DocSearch */
+
+html[data-theme="light"] .DocSearch-Button {
+  --docsearch-searchbox-background: #fff;
+}
+
+html[data-theme="dark"] .DocSearch-Button {
+  --docsearch-searchbox-background: #1f1f1f;
+}
+
+span.DocSearch-Button-Key {
+  display: none;
+}
+
+/* Navbar */
+
+html[data-theme="dark"] .navbar-github-link:before {
+  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+    no-repeat;
+}
+
+html[data-theme="dark"] .docusaurus-highlight-code-line {
+  background-color: rgba(0, 0, 0, 0.3);
+}
+
+.navbar-github-link:before {
+  content: "";
+  width: 24px;
+  height: 24px;
+  display: flex;
+  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+    no-repeat;
+}
+
+.navbar__link svg {
+  display: none;
+}
+
+/* DocsPage */
+
+article {
+  max-width: var(--ifm-docs-page-max-width);
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.docusaurus-highlight-code-line {
+  background-color: rgba(0, 0, 0, 0.1);
+  display: block;
+  margin: 0 calc(-1 * var(--ifm-pre-padding));
+  padding: 0 var(--ifm-pre-padding);
+}
+
+/* TOC */
+
+.table-of-contents {
+  font-size: 0.85rem;
+}
+
+.table-of-contents::before {
+  content: "ON THIS PAGE";
+  display: inline-block;
+  font-size: 0.85rem;
+  padding-bottom: 4px;
+}
+
+.table-of-contents .table-of-contents__link--active {
+  border-left: 3px solid var(--ifm-link-color);
+  color: var(--ifm-color-primary);
+  font-weight: 500;
+  margin-left: -14px;
+  padding-left: 10px;
+}
+
+/* Sidebar */
+
+.main-wrapper aside {
+  z-index: var(--ifm-z-index-fixed);
+}
+
+.sidebar-bg {
+  background: var(--ifm-medusa-gray);
+  height: 100%;
+}
+
+.padding-top--md {
+  padding-top: 2rem !important;
+}
+
+a.menu__link.menu__link--active.active {
+  border-left: 4px solid var(--ifm-color-primary);
+  padding-left: 12px;
+}
+
+/* Pagination */
+
+.pagination-nav {
+  margin-left: auto;
+  margin-right: auto;
+  max-width: var(--ifm-docs-page-max-width);
+}
+
+.navbar {
+  padding-left: 32px;
+  padding-right: 32px;
+}
+
+/* Footer */
+
+footer .footer__items svg {
+  display: none;
+}
+
+footer .footer__item a:hover {
+  color: white;
+}
+
+@media screen and (min-width: 966px) {
+  footer .footer__col {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+  }
+}
+
+footer .footer__items li {
+  width: 150px;
+}
+
+footer .footer__title {
+  width: 150px;
+}
+
+.footer--dark {
+  --ifm-footer-background-color: #333;
+}
+
+.react-toggle {
+  display: none;
+}