OSCHINA-MIRROR/wi1dcard-weekly-report

Пишите еженедельные отчёты по-кодерски!

⬆️ Это моя идея. GitHub / Gitee.

🔧 Извлечение записей Git-коммитов для быстрой генерации Markdown-отчётов за день или неделю, призванных помочь таким забывчивым программистам, как я, быстро составлять рабочие записи.

⚠️ Это не стандартный проект, а скорее полезное маленькое приложение.

Эффект

Краткое руководство

Сначала вам нужно установить этот инструмент, см. раздел «Как установить».
С чего начать писать еженедельный отчёт? Давайте начнём с шаблона.
```
php toolkit/new
```
Просмотрите каталог posts, шаблон этой недели уже создан, имя файла — годWнеделя.md.

Это имя файла можно напрямую преобразовать в строку с помощью PHP strtotime, вы можете изменить конфигурацию в toolkit/config.php, чтобы реализовать пользовательские настройки.

Теперь откройте этот файл конфигурации и найдите самый нижний элемент projects, настройте свой проект.

// ...
'projects' => [
    'Один потрясающий проект' => [ // Изменить по мере необходимости
        'path' => realpath('Локальный каталог репозитория Git'), // Изменить по мере необходимости
    ],
]

Хорошо, подумайте о том, что вы сегодня зафиксировали в этом проекте. Сегодня ничего не зафиксировано? Вчера тоже подойдёт.
```
php toolkit/today # Создать ежедневный отчёт
php toolkit/today -1 # Создать вчерашний отчёт
php toolkit/today -2 # Создать позавчерашний отчёт
# ... И так далее
```
Сгенерированная таблица уже отформатирована, просто скопируйте и вставьте её в шаблон еженедельного отчёта.
Со временем вам понадобится легко читаемый каталог вместо того, чтобы пытаться вспомнить, к какому месяцу относится ****W?
```
php toc
```
Он просканирует указанный каталог еженедельных отчётов и автоматически создаст каталог.
Если у вас есть какие-либо вопросы или идеи, пожалуйста, создайте Issue.

Также приветствуются PR, спасибо.

Как установить

Требования:
- PHP >= 7.0
- Composer
- Git
- Git Bash (только Windows)
Используйте Git для клонирования этого проекта или загрузите Zip-архив.
Установите зависимости:
```
cd toolkit
composer install
```
Весь код находится в каталоге toolkit, вы можете прочитать toolkit/README.md для получения более подробной информации.

Часто задаваемые вопросы

Шрифт

Рекомендуется использовать шрифт с одинаковой шириной для китайских и английских символов, например, M+ 1M или Courier New 12.

Я сейчас использую Inconsolata.

Преобразование Markdown в PDF

Пользователи macOS могут использовать MacDown.
Пользователи VS Code могут использовать Markdown PDF, но этот инструмент в настоящее время не поддерживается и имеет некоторые проблемы.

В настоящее время я использую последний, конфигурация проекта VS Code см. здесь.

Рекомендуется выбрать инструмент преобразования, который позволяет настраивать CSS, чтобы было легче настроить стиль, иначе сгенерированные таблицы могут быть трудночитаемыми.

Что касается CSS, вы можете напрямую использовать css/gitee.css, и внешний вид будет таким же, как на веб-странице Gitee. На самом деле это просто копирование, авторские права принадлежат Gitee.

Копирование содержимого еженедельного отчёта прямо в буфер обмена

Вот команды для macOS, для Windows и Linux аналогично.

Скопируйте в буфер обмена:

php toolkit/today | pbcopy

Скопируйте в буфер обмена и отобразите в терминале:

php toolkit/today | tee >(pbcopy)

Лицензия

MIT