Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/pimenovoleg/web-handnotes

mkdocs

Last synced: 3 months ago
JSON representation

My handnotes

# My Handnotes

## Структура заметок

* ```mkdocs.yml``` основной файл конфигурации.
* ```./src``` содержит исходники заметок, разметку и изображения.

## Разработка

### Пререквизиты

Используется [**MkDocs**](https://www.mkdocs.org/) и [**Material for MkDocs**](https://squidfunk.github.io/mkdocs-material/).

1. Python 3.7 или выше.
3. npm install
4. pip install -r requirements.txt

### Локальный сервер

```console
npm run start
```

### Сборка

```console
mkdocs build --clean
```

### Форматирование

```.markdownlintrc```.

```console
npm run lint
```

Исправление ошибок

```console
npm run lint:fix
```