Введение: зачем использовать vuepress

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

У большинства инструментов для создания сайтов были другие проблемы:

• Их было слишком сложно настроить
• Они требовали, чтобы я писал с использованием текстового процессора, который генерировал HTML. Звучит нормально, но всегда были проблемы с выводом, особенно когда были затронуты примеры кода или кириллицы
• Созданные ими сайты медленно работали и требовали много памяти
• Они требуют использования отдельной базы данных
• Им не хватало встроенного поиска
• Их сложно было расширять
• Экспорт работы в другой формат был излишне сложным
• У них были чрезмерно ограничительны условия лицензирования

VuePress ответил на все эти проблемы в различной степени. Вот некоторые из моих любимых аспектов VuePress:

• VuePress сайты загружаются быстро.
• Тема по умолчанию очень хорошо подходит для представления техническая информация, потому что она была разработана для сайта Vue.js. Она хорошо выглядит из коробки и его можно изменить благодаря использованию Stylus.
• Сайт VuePress - это просто набор файлов Markdown. Markdown - это не более чем текст, отформатированный определенным образом, и сохранено в файле, заканчивающемся расширением .md.

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

# Начни здесь

Краткое примечание: новичкам может понадобиться просмотреть [документ](/glossary.md) прежде чем продолжить.

Если бы вам пришлось написать это в HTML, это выглядело бы так:

<h1> Начните здесь </h1>

Краткое примечание: новичкам может понадобиться просмотреть
<a href="glossary.html"> документ </a>, прежде чем продолжить.

Markdown легче читать даже в необработанном виде, легче писать, и проще в обслуживании. Если вы решили, что вам не нравится VuePress, вы может использовать markdown во многих других статических генераторах сайтов, таких как Jekyll или Ghost.

• VuePress имеет встроенный поиск по-содержимому заголовков. На практике, организовывать документы лучше зная, что немного ограничен.
• VuePress имеет встроенную поддержку систем контроля версий, таких как GitHub, GitLabe и BitBucket
• VuePress генерирует статический сайт, который можно размечать на бесплатных хостингах, например: Netlify, Firebase

Для кого подойдет VuePress?

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

Также это хороший инструмент для начального знакомства с экосистемой vue, в благодаря поддержке компонентов vue во vuepress из коробки.

Особенности использования VuePress

• Поскольку VuePress создает статические сайты, нет взаимодействия с пользователем, о котором знает сервер. В некоторой степени вы можете смягчить это, используя Firebase.
• Как уже упоминалось здесь, вы должны быть знакомы с текстовым редактором, таким как Visual Studio Code, Emacs или Vim. Вы будете создавать файлы Markdown в редакторе, отдельном от генератора веб-сайтов (который является VuePress).