[Work In Progress] First release

.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["next/babel"],
+  "plugins": ["styled-components"]
+}

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 2
+trim_trailing_whitespace = true

.env.example

@@ -0,0 +1 @@
+NEXT_PUBLIC_URL=https://ml-handbook.ru

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["next/core-web-vitals", "prettier"]
+}

.gitignore

@@ -1,3 +1,31 @@
-node_modules/
-.cache/
-public
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+.env*
+!.env.example
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+public/handbook/**
+
+# Local Netlify folder
+.netlify

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+build
+coverage
+handbook

.prettierrc.json

@@ -0,0 +1 @@
+{}

.stylelintrc.json

@@ -0,0 +1,11 @@
+{
+  "extends": ["stylelint-config-standard", "stylelint-config-idiomatic-order", "stylelint-config-prettier"],
+  "rules": {
+    "at-rule-no-unknown": [
+      true,
+      {
+        "ignoreAtRules": ["tailwind", "apply", "variants", "responsive", "screen"]
+      }
+    ]
+  }
+}

README.md

@@ -1,54 +1,77 @@
 <p align="center">
-  <a href="https://www.gatsbyjs.com/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter">
-    <img alt="Gatsby" src="https://www.gatsbyjs.com/Gatsby-Monogram.svg" width="60" />
-  </a>
+  <img alt="Школа Анализа Данных" src="./shad.png" height="250" />
 </p>
 <h1 align="center">
-  ML Handbook (Gatsby minimal starter)
+  Учебник по машинному обучению «Школы Анализа Данных»
 </h1>
 
-## 🚀 Quick start
+## 🚀 Как работать с проектом?
 
-1.  **Create a Gatsby site.**
+1. **Склонируйте репозиторий.**
 
-    Use the Gatsby CLI to create a new site, specifying the minimal starter.
+   ```shell
+   git clone [email protected]:yandexdataschool/ML-Handbook.git
+   ```
 
-    ```shell
-    # create a new Gatsby site using the minimal starter
-    npm init gatsby
-    ```
+2. **Запустите локально.**
 
-2.  **Start developing.**
+   Перейдите в каталог сайта и запустите его.
 
-    Navigate into your new site’s directory and start it up.
+   ```shell
+   cd ml-handbook/
+   npm run develop
+   ```
 
-    ```shell
-    cd my-gatsby-site/
-    npm run develop
-    ```
+3. **Откройте редактор и начните работу!**
 
-3.  **Open the code and start customizing!**
+   Сайт теперь работает на http://localhost:8000!
 
-    Your site is now running at http://localhost:8000!
+   Отредактируйте любой файл в папке `./src` чтобы видеть обновление сайта в режиме реального времени!
 
-    Edit `src/pages/index.js` to see your site update in real-time!
+4. **Работа с контентом**
 
-4.  **Learn more**
+   Контент страниц находится в папке `./src/pages/chapters/*` и повторяет такую же структуру для страниц сайта.
+   Т.е., например, страница из `./src/pages/chapters/intro.mdx` будет доступна по адресу
+   `http://localhost:8000/chapters/intro`.
 
-    - [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   Или, например, `./src/pages/chapters/ansamblees/intro.mdx` будет доступна по адресу
+   `http://localhost:8000/chapters/ansamblees/intro`.
 
-    - [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   Файлы должны иметь расширение `*.mdx`. MDX – это расширенный формат для маркдауна.
+   Он позволяет использовать интерактивные (`React`) компоненты прямо внутри маркдаун разметки.
+   Это упрощает работу с содержимым. Инструкция по тому, какие компоненты можно использовать внутри MDX будет чуть
+   позже.
 
-    - [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   В начале каждого MDX-файла есть раздел, который называется frontmatter:
 
-    - [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   ```
+   ---
+   title: Ансамбли в машинном обучении
+   author: pavel_gubko
+   ---
+   ```
 
-    - [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   В нём мы указываем название и автора. Позже появится еще изображение. Содержание статьи будет строиться на
+   основе заголовков.
 
-    - [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+   В остальном — это самый обычный markdown.
 
-## 🚀 Quick start (Gatsby Cloud)
+   Так как сейчас подключен Netlify, то при создании PR автоматически собирается превью того, что было сделано.
+   Рекомендую использовать эту возможность, создавать ветки из `develop` и делать PR на каждую ветку.
+   После merge в `develop` или `main` на Github – автоматически происходит сборка проекта и его деплой.
 
-Deploy this starter with one click on [Gatsby Cloud](https://www.gatsbyjs.com/cloud/):
+   Чтобы получить доступ к превью каждого PR – запросите доступ к Netlify у Дарьи Данилюк или Анастасии Павловской.
 
-[<img src="https://www.gatsbyjs.com/deploynow.svg" alt="Deploy to Gatsby Cloud">](https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/gatsbyjs/gatsby-starter-minimal)
+5. **Документация к Gatsby**
+
+   - [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+
+   - [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+
+   - [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+
+   - [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+
+   - [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
+
+   - [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

__mocks__/fast-glob.js

@@ -0,0 +1,15 @@
+const glob = jest.createMockFromModule("fast-glob");
+
+let mockFiles = [];
+function __setMockFiles(newMockFiles) {
+  mockFiles = newMockFiles;
+}
+
+function sync(source) {
+  return mockFiles;
+}
+
+glob.__setMockFiles = __setMockFiles;
+glob.sync = sync;
+
+module.exports = glob;

__mocks__/fileMock.js

@@ -0,0 +1 @@
+(module.exports = "test-file-stub")

__mocks__/styleMock.js

@@ -0,0 +1 @@
+module.exports = {};

authors/alexey_gorchakov/index.md

@@ -0,0 +1,4 @@
+---
+name: Алексей Горчаков
+tg: yandex_alg_orc
+---

authors/dmitry_norkin/index.md

@@ -0,0 +1,4 @@
+---
+name: Дмитрий Норкин
+tg: nordmtr
+---

authors/evgenia_elistarova/index.md

@@ -0,0 +1,4 @@
+---
+name: Евгения Елистратова
+tg: evg3307
+---

authors/evgenii_sokolov/index.md

@@ -0,0 +1,3 @@
+---
+name: Евгений Соколов
+---

authors/filipp_sinicin/index.md

@@ -0,0 +1,3 @@
+---
+name: Филипп Синицин
+---

authors/ivanov_sergei/index.md

@@ -0,0 +1,4 @@
+---
+name: Сергей Иванов
+email: [email protected]
+---

authors/kirill_lunev/index.md

@@ -0,0 +1,3 @@
+---
+name: Кирилл Лунёв
+---

authors/maria_burkina/index.md

@@ -0,0 +1,3 @@
+---
+name: Мария Буркина
+---

authors/michail_artemiev/index.md

@@ -0,0 +1,4 @@
+---
+name: Михаил Артемьев
+email: [email protected]
+---

authors/pavel_gubko/index.md

@@ -0,0 +1,4 @@
+---
+name: Павел Губко
+tg: gubkopaul
+---

authors/radoslav_neichev/index.md

@@ -0,0 +1,6 @@
+---
+name: Радослав Нейчев
+email: [email protected]
+linkedIn: radoslav-neychev
+tg: neychev
+---

authors/roman_ushakov/index.md

@@ -0,0 +1,3 @@
+---
+name: Роман Ушаков
+---

authors/senya_ashuha/index.md

@@ -0,0 +1,3 @@
+---
+name: Арсений Ашуха
+---

authors/stanislav_fedotov/index.md

@@ -0,0 +1,4 @@
+---
+name: Станислав Федотов
+email: [email protected]
+---

authors/tyapkin_daniil/index.md

@@ -0,0 +1,3 @@
+---
+name: Даниил Тяпкин
+---

authors/victor_kantor/index.md

@@ -0,0 +1,3 @@
+---
+name: Виктор Кантор
+---

authors/yanina_anastasia/index.md

@@ -0,0 +1,3 @@
+---
+name: Анастасия Янина
+---

components/Content/Content.styles.tsx

@@ -0,0 +1,6 @@
+import styled from 'styled-components';
+
+export const Content = styled.section`
+  box-sizing: border-box;
+  padding: 30px 40px 100px;
+`;

components/Content/Content.tsx

@@ -0,0 +1,11 @@
+import { ReactNode } from "react";
+
+import * as Styles from './Content.styles';
+
+type Props = {
+  children: ReactNode;
+};
+
+export const Content = ({ children }: Props) => {
+  return <Styles.Content className="prose max-w-max">{children}</Styles.Content>;
+};

components/CustomLink/CustomLink.tsx

@@ -0,0 +1,11 @@
+import Link from "next/link";
+
+export const CustomLink = ({ as, href, ...otherProps }) => {
+  return (
+    <>
+      <Link as={as} href={href}>
+        <a {...otherProps} />
+      </Link>
+    </>
+  );
+};

components/Details/Details.tsx

@@ -0,0 +1,5 @@
+
+export const Details = ({ children }) => {
+  return <details>{children}</details>;
+};
+

components/Example/Example.styles.tsx

@@ -0,0 +1,5 @@
+import styled from "styled-components";
+
+export const Example = styled.div`
+  color: red;
+`;

components/Example/Example.tsx

@@ -0,0 +1,11 @@
+import { ReactNode } from "react";
+
+import * as Styles from "./Example.styles";
+
+type Props = {
+  children: ReactNode;
+};
+
+export const Example = ({ children }: Props) => {
+  return <Styles.Example>{children}</Styles.Example>;
+};

components/Footer/Footer.tsx

@@ -0,0 +1,9 @@
+export const Footer = () => {
+  return (
+    <footer className="flex flex-col align-bottom justify-end w-full h-20 px-10 py-3 bg-black bg-opacity-80">
+      <p className="text-sm text-right text-gray-500">
+        &#169; Школа анализа данных, 2007 — 2021. ООО «Яндекс» не оказывает образовательных услуг
+      </p>
+    </footer>
+  );
+};

components/Header/Header.tsx

@@ -0,0 +1,18 @@
+import Image from "next/image";
+import Link from "next/link";
+
+import logo from "../../public/images/shad-logo.svg";
+import { imageLoader } from "../../utils/imageLoader";
+
+export const Header = () => {
+  return (
+    <header className="flex w-full px-5 py-3 justify-center shadow-md">
+      <div className="absolute left-5 cursor-pointer">
+        <Link href="/" passHref>
+          <Image loader={imageLoader} src={logo} alt="Логотип Школы Анализа Данных" />
+        </Link>
+      </div>
+      <p className="max-w-3xl w-full">ML–Учебник</p>
+    </header>
+  );
+};

components/HeaderArticle/HeaderArticle.tsx

@@ -0,0 +1,18 @@
+import Image from "next/image";
+import Link from "next/link";
+
+import logo from "../../public/images/shad-logo.svg";
+import { imageLoader } from "../../utils/imageLoader";
+
+export const HeaderArticle = () => {
+  return (
+    <header className="flex w-full px-5 py-3 justify-center shadow-md">
+      <div className="absolute left-5 cursor-pointer">
+        <Link href="/" passHref>
+          <Image loader={imageLoader} src={logo} alt="Логотип Школы Анализа Данных" />
+        </Link>
+      </div>
+      <p className="max-w-3xl w-full">ML–Учебник</p>
+    </header>
+  );
+};