feat(docs): add last time edit date #349

Lullabyq · 2024-12-09T10:02:14Z

Часть 1 - вывод тега с датой последнего обновления статьи

по умолчанию дата выводится в правом нижнем углу статьи

мы решили выводить ее в начале каждой статьи в виде тега

Часть 2 - выводим 5 последних статей на отдельной странице

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

---
recent_article:
  // Была ли статья добавлена впервые
  new?: true
  
  // массив тезисов с изменениями в статье
  theses?: 
    - Исправили ошибку
    - Добавили ссылку
    - Уточнили пункт сценария
    
   // если выставлено в true то статья:
   // 1) не будет показана среди недавно обновленных 
   // 2) внутри статьи не будет отрисован тэг с датой ее обновления
  ignore?: true 
  
---

netlify · 2024-12-09T10:02:38Z

✅ Deploy Preview for sendsay-docs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`533f653`
🔍 Latest deploy log	https://app.netlify.com/sites/sendsay-docs/deploys/679cf5441906960008197232
😎 Deploy Preview	https://deploy-preview-349--sendsay-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Lullabyq · 2024-12-09T10:02:53Z

docusaurus.config.ts

@@ -45,6 +45,7 @@ const config: Config = {
        docs: {
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
+          showLastUpdateTime: true,


это новое поле, остальное это линтер отрефакторил

Lullabyq · 2025-01-22T14:11:07Z

src/plugins/docs-plugin-extended/index.js

+      actions.addRoute({
+        path: RECENT_ARTICLES_TEMP_URL,
+        exact: true,
+        component: '@site/src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticles.js',
+        modules: {
+          recentArticles,
+        },
+      });


на моменте обработки данных мы добавляем роут и рендерим в нем компонент, данная статья недоступна пользователям, не должна показываться в поиске и не индексируется

Lullabyq · 2025-01-22T14:12:36Z

src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticles.js

это компонент который мы рендерим на этой странице - его можно посмотреть по прямой ссылке
https://deploy-preview-349--sendsay-docs.netlify.app/updates/BC1ADF523

Lullabyq · 2025-01-22T14:14:52Z

src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticlesIframe.tsx

+    <iframe
+      ref={iframeRef}
+      src={RECENT_ARTICLES_TEMP_URL}
+      name="latest-articles"
+      className="w-full"
+      style={{
+        border: 'none',
+        outline: 'none',
+      }}
+      onLoad={resizeIframe}
+      scrolling="no"
+      seamless="seamless"
+    />


следом нам нужен iframe который будет отображать статью в нужном нам месте (самое простое решение для того чтобы в статье был сайдбар и тайтл)

Lullabyq · 2025-01-22T14:16:13Z

docs/updates/docs-list/recent-articles.mdx

+import { RecentlyUpdatedArticlesIframe } from '@site/src/components/RecentlyUpdatedArticles';
+
+<RecentlyUpdatedArticlesIframe />


дальше мы добавляем статью в которой данный iframe рендерится с нужным нам лейаутом

Lullabyq · 2025-01-22T14:21:02Z

src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticlesIframe.tsx

+    iframeRef.current?.contentWindow.document.addEventListener('redirect', handleRedirectInIframe);
+  };


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

если сделать history.push внутри айфрейма то мы откроем страницу в маленьком окошке iframa оставшись на странице с обновлениями документации

всякие window.parent.location.href приводили к перезагрузке страницы и терялась одностраничность приложения

Lullabyq · 2025-01-22T16:30:32Z

docs/account-settings/how-to-create-sublogin.md

+recent_article:
+  theses:
+    - Пример
+    - Изменения
+    - 24 правки текста


удалить перед релизом

Lullabyq · 2025-01-22T16:30:42Z

docs/automations/autoimport/how-to-set-autoexport.mdx

+recent_article:
+  new: true


удалить перед релизом

Matveev89 · 2025-01-28T13:57:16Z

Тут наверное какая-то высота задана фиксированная? Если контента накинуть - не вмещается уже последняя карточка

Lullabyq · 2025-01-28T15:12:21Z

это приколы с iframe он на моменте загрузки вычисляет высоту и выставляет по размеру, нужно добавить перерасчет для ресайза, спасибо

src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticles.js

src/theme/DocItem/Layout/index.tsx

Lullabyq · 2025-01-31T15:06:44Z

package.json

    "react": "^18.2.0",
    "react-dom": "^18.2.0",
-    "tailwindcss": "^3.4.1"
+    "tailwindcss": "^3.4.1",
+    "html-entities": "2.5.2",


добавил новый пакет чтобы конвертить html entities в unicode для корректного вывода в тегах html

Lullabyq added the PR: Needs Code Review 🔥 label Dec 9, 2024

Lullabyq self-assigned this Dec 9, 2024

Lullabyq commented Dec 9, 2024

View reviewed changes

Lullabyq force-pushed the feat/last-edit-date branch from 72ef415 to 2cd6d64 Compare December 9, 2024 12:21

Lullabyq added PR: Code Accepted and removed PR: Needs Code Review 🔥 labels Dec 10, 2024

Lullabyq force-pushed the feat/last-edit-date branch 2 times, most recently from 7c11115 to 76f7497 Compare December 11, 2024 08:31

Lullabyq added PR: Needs Code Review 🔥 and removed PR: Code Accepted labels Dec 11, 2024

Lullabyq force-pushed the feat/last-edit-date branch 4 times, most recently from 7030052 to d0e2af4 Compare January 22, 2025 14:07

Lullabyq commented Jan 22, 2025

View reviewed changes

Lullabyq force-pushed the feat/last-edit-date branch 2 times, most recently from 8e7dfaf to 053acaf Compare January 22, 2025 14:57

Lullabyq added 8 commits January 22, 2025 19:06

feat(docs): add last time edit date

eb6476b

use translate func

ef042ab

use locale

ad3ec0c

format date correctly

ef65c91

fix wrong year date bug

bc21f9e

upgrade version

715e996

preliminary commit

9e8b5af

try

a3f3b84

Lullabyq force-pushed the feat/last-edit-date branch from 053acaf to a3f3b84 Compare January 22, 2025 16:06

fix linter

fe13dad

Lullabyq commented Jan 22, 2025

View reviewed changes

Lullabyq added 4 commits January 23, 2025 12:37

move article

51c54da

change bg for tag of new articles

66c2fcb

remove some feedback on index pages

3a0af87

decrease padding

1970358

add onresize

346a91f

Matveev89 approved these changes Jan 29, 2025

View reviewed changes

src/components/RecentlyUpdatedArticles/RecentlyUpdatedArticles.js Outdated Show resolved Hide resolved

src/theme/DocItem/Layout/index.tsx Outdated Show resolved Hide resolved

aleksnick approved these changes Jan 30, 2025

View reviewed changes

aleksnick added PR: Code Accepted and removed PR: Needs Code Review 🔥 labels Jan 30, 2025

fix html entities decoding

62d4d57

Lullabyq commented Jan 31, 2025

View reviewed changes

Merge branch 'stable' into feat/last-edit-date

533f653

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): add last time edit date #349

feat(docs): add last time edit date #349

Lullabyq commented Dec 9, 2024 •

edited

Loading

netlify bot commented Dec 9, 2024 •

edited

Loading

Lullabyq Dec 9, 2024

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Lullabyq Jan 22, 2025

Matveev89 commented Jan 28, 2025

Lullabyq commented Jan 28, 2025 •

edited

Loading

Lullabyq Jan 31, 2025

		import { RecentlyUpdatedArticlesIframe } from '@site/src/components/RecentlyUpdatedArticles';

		<RecentlyUpdatedArticlesIframe />

		iframeRef.current?.contentWindow.document.addEventListener('redirect', handleRedirectInIframe);
		};

feat(docs): add last time edit date #349

Are you sure you want to change the base?

feat(docs): add last time edit date #349

Conversation

Lullabyq commented Dec 9, 2024 • edited Loading

Часть 1 - вывод тега с датой последнего обновления статьи

Часть 2 - выводим 5 последних статей на отдельной странице

netlify bot commented Dec 9, 2024 • edited Loading

✅ Deploy Preview for sendsay-docs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Matveev89 commented Jan 28, 2025

Lullabyq commented Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

Lullabyq commented Dec 9, 2024 •

edited

Loading

netlify bot commented Dec 9, 2024 •

edited

Loading

Lullabyq commented Jan 28, 2025 •

edited

Loading