Przejdź do treści

Import plików Markdown

Jak zaimportować istniejącą dokumentację w formacie Markdown do bazy wiedzy Fibly.

Jeśli prowadzisz dokumentację w narzędziu, które eksportuje pliki .md (np. GitBook, Docusaurus, Notion, Outline), możesz przenieść ją do Fibly w kilku kliknięciach.

Krok 1: przygotuj pliki

Wyeksportuj dokumentację do plików .md. Każdy plik staje się jednym artykułem w bazie wiedzy. Tytuł artykułu Fibly bierze z pola title we frontmatterze YAML, jeśli plik je ma; w przeciwnym razie z pierwszego nagłówka #; a dopiero gdy nie ma żadnego z nich, z nazwy pliku. Zalecamy:

  • nadać każdemu plikowi jasny nagłówek # albo krótką, jasną nazwę,
  • usunąć z plików metadane specyficzne dla starego narzędzia (np. niestandardowe shortcode'y),
  • zachować standardową składnię Markdown (nagłówki #, listy, linki, bloki kodu).

Krok 2: uruchom import w panelu

  1. Przejdź do zakładki Baza wiedzy i otwórz dokumentację, do której chcesz importować.
  2. Kliknij Importuj Artykuły nad listą artykułów.
  3. Przeciągnij pliki .md do okna importu lub wybierz je przez eksplorator. Możesz też przeciągnąć całe foldery; Fibly weźmie wszystkie pliki .md z ich wnętrza.
  4. Potwierdź przyciskiem Importuj.

Limity

  • maksymalnie 250 plików na jeden import,
  • akceptowane są tylko pliki .md,
  • maksymalnie 20 480 znaków treści w pojedynczym artykule. Dłuższe pliki zostaną pominięte, więc podziel je na mniejsze przed importem.

Statusy importu

Każdy plik podczas importu trafia w jeden ze stanów:

  • Utworzony: nowy artykuł powstał w bazie wiedzy.
  • Zaktualizowany: artykuł o tym samym tytule istniał, treść została podmieniona.
  • Bez zmian: istniejący artykuł miał identyczną treść.
  • Pominięty: Fibly nie był w stanie sparsować pliku (zwykle niepoprawny format) albo plik przekraczał limit długości artykułu.

Wcześniejsze importy i status każdego pliku znajdziesz w sekcji Historia importów pod listą artykułów.

Po imporcie

Otwórz losowo kilka zaimportowanych artykułów i sprawdź, czy zachowały formatowanie. Jeśli coś wymaga poprawki, edytuj bezpośrednio w panelu (zob. Ręczne pisanie artykułów).

Co dalej

Zastanów się, które z zaimportowanych artykułów warto przypiąć. To one będą miały największy wpływ na odpowiedzi bota.