Источник вдохновения 🌟

Есть чему поучиться Докузавр. Это мощный генератор статических сайтов с потрясающими функциями. Я представляю свой собственный генератор статических сайтов — война — когда-нибудь стать таким же могущественным, как Докузавр. Но опять же — я команда из одного человека, единственный автор моего генератора статических сайтов, получаю небольшую помощь от других товарищей по классу и предпринимаю небольшие шаги, чтобы в один прекрасный день стать таким же функциональным, как Docusaurus. Но пока я не тороплюсь, изучая python по мере улучшения rwar.


Что такое Докузавр? Объясни, будто мне пять.

Помните, что ребенок, прославившийся на YouTube за его обзоры игрушек. Давайте представим, что мы хотим сделать то же самое — поговорить об игрушках, — но вместо того, чтобы снимать видео, мы хотим использовать изображения и слова, чтобы рассказать всем нашим друзьям о том, что нам понравилось или не понравилось в наших игрушках. Итак, мы открываем наш компьютер, печатаем наши чувства по поводу наших игрушек, а затем сохраняем их как что-то, называемое уценка файл. Но ох. Мы не умеем создавать сайты, а может и умеем, но у нас мало времени. Так что же нам делать? Принимаем помощь Докузавра. У Docusaurus есть ряд простых шагов, которые нужно выполнить, как указано на его веб-сайте. с чего начать с помощью этого удивительного инструмента. Затем мы следуем шагам, а затем сдаем небольшие абзацы, которые мы написали ранее о наших игрушках. Затем Docusaurus превращает его в красивый веб-сайт, которым мы можем поделиться с кем угодно в мире.


Что такое Докузавр? Объясните, как будто я младший разработчик

Как указано на их официальном сайте:

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

документация докузавра предоставляет все, что вам нужно знать, чтобы приступить к созданию собственного сайта документации, не беспокоясь о его инфраструктуре. Он также поставляется с мощными функциями, такими как поиск и управление версиями.


Мой опыт использования Docusaurus 🦖

Мне было очень легко создать быстрый сайт с помощью Docusaurus благодаря четкой и лаконичной документации. Сначала у меня были проблемы с развертыванием сайта на GitHub Pages, и он говорил, что у меня проблемы с baseURL. Я снова прочитал их документацию и смог исправить проблему и получить сайт запущен и работает.


Функция, которую я скопировал

Я решил внедрить полную функцию поддержки уценки для rwar, потому что это только усилило поддержку уценки, которую rwar уже обеспечивал. Я использовал библиотеку markdown2 для поддержки этой функции. Сделать этот шаг было довольно легко, и я не столкнулся с какими-либо проблемами. Однако я понял, что подсветка синтаксиса отсутствует в блоках кода, и я зарегистрировал проблему, чтобы решить эту проблему в будущем.


Что такое уценка2?

Из их Документация репозитория GitHub:

Это (markdown2) — быстрая и полная реализация Markdown на Python. Он был написан так, чтобы точно соответствовать поведению оригинального Markdown.pl, реализованного на Perl. Markdown2 также поставляется с рядом расширений (называемых «дополнительными») для таких вещей, как раскраска синтаксиса, таблицы, идентификаторы заголовков. См. раздел «Дополнительный синтаксис» ниже. «markdown2» поддерживает все версии Python 3.5+ (а также pypy и jython, хотя я не часто их тестирую).

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


Вперёд 🚀….

У меня много работы, чтобы двигаться вперед. Я понял, что подсветка синтаксиса не поддерживается для моих блоков кода, и мне нужно начать работать над этим в ближайшее время! Я хочу иметь возможность поддерживать все функции, перечисленные ниже, поскольку я продолжаю работать над rwar.

  • Поисковая оптимизация (SEO), включая метатеги в заголовке HTML
  • Улучшена доступность сгенерированного HTML
  • Темы
  • Плагины
  • Настраиваемая боковая панель (например, оглавление)
  • Подсветка синтаксиса для блоков кода
  • Поиск
  • Статические активы для изображений, таблиц стилей и т. д.
  • Поддержка Markdown Frontmatter
  • Сообщения в блогах в дополнение к страницам