mr: self-review

#169

Author: azinit

src/features/repo-explorer/components/readme/index.scss

@@ -8,46 +8,47 @@
     }
 
     &__markdown {
+        // [github-styles] offsets
         > :first-child {
             margin-top: 0 !important;
         }
-
+        // [github-styles] headers offsets
+        h1,
+        h2,
+        h3,
+        h4,
+        h5,
+        h6 {
+            margin-top: 24px;
+            margin-bottom: 16px;
+        }
+        // [github-styles] <code />
         code {
             padding: 1px 4px;
             background: var(--clr-gray--100);
             border-radius: 6px;
         }
-
+        // [github-styles] dividers for h1, h2
         h1,
         h2 {
             padding-bottom: 0.3em;
             border-bottom: 1px solid var(--clr-gray--200);
         }
-
+        // [github-styles] headers font-sizes
         h3 {
             font-size: 20px;
         }
-
+        // [github-styles] headers font-sizes
         h4 {
             font-size: 16px;
         }
-
-        h1,
-        h2,
-        h3,
-        h4,
-        h5,
-        h6 {
-            margin-top: 24px;
-            margin-bottom: 16px;
-        }
-
+        // [github-styles] for markdown quotes
         blockquote {
             padding: 0 1em;
             color: var(--clr-gray--800);
             border-left: 0.25em solid var(--clr-gray--200);
         }
-
+        // [github-styles] limit images max-width
         img {
             max-width: 100%;
         }

src/features/repo-explorer/components/readme/index.tsx

@@ -24,6 +24,9 @@ type Props = {
 
 /**
  * @hook Обработка внутренних ссылок
+ * @remark
+ * - В README могут быть указаны ссылки на локальные ресурсы репозитория (images, files, anchors, ...)
+ * - Поэтому, для корректной навигации и отображения, было решено предобрабатывать подобные ссылки
  */
 const useLocalUri = ({ repoUrl, branch }: Props) => {
     /**