В каком формате файла лучше всего организовать «шпаргалку» проекта, открываемую в VSC?

Question

[Роми]

Немного странный вопрос :) но самому в голову ничего не приходит.

Для каждого проекта я обычно создаю шпаргалку - текстовый файл, куда пишу всякие рутинные штуки (вроде команд для терминала), заметки с кодом на память, и т.п.

В результате по ходу проекта образуется такая длинная простынь )) из того и сего.

Чтобы хоть как-то оно подсвечивалось - я говорю VSC что это shell-скрипт )) но по факту там может быть самое разное - команды для Artisan например, Git, всё что угодно.

Хочу чтобы это еще более разнообразно подсвечивалось :) и можно было ставить маркеры, по которым потом кликом мыши можно будет фолдить эту простыню, и чтобы в свернутом виде было понятно, что именно в том или ином разделе-фолде.

Как такое сделать? (надеюсь что внятно донес суть потребности)))

Answer 1

[Василий Банников]

Можно например в markdown - там можно у блоков кода писать, какой именно язык внутри записан.

Answer 2

[Владимир Куц]

Обычно принято создавать файл README.md в корне проекта, в котором на языке Markdown как раз и делается все то что вы описали в вопросе.