Eine Dokumentations-Website erstellen

dokumentation gibt es in vielen formen und ausführungen möglicherweise hast du bereits einige ressourcen oder musst ganz von vorne beginnen lass uns durchgehen, wie du inhalte mit archbee hinzufügst w rite in archbee sobald du ein neues dokument erstellt hast, kannst du beginnen, inhalte hinzuzufügen – entweder mit markdown shortcuts oder einem der 30+ benutzerdefinierten blöcke die benutzerdefinierten blöcke helfen dir, den inhalt nach bedarf zu formatieren um sie zu öffnen, tippe einen schrägstrich / im editor und gehe die optionen durch die blöcke sind gruppiert unter basic , media , developer , embed , und content reuse wenn du beispielsweise dynamisch auf andere dokumente verlinken möchtest, tippe @ und den dokumenttitel dadurch wird die verbindung zur dokument id hergestellt wenn du den titel oder die position des dokuments änderst, verweist der link weiterhin darauf ein weiteres beispiel ist das aufrufen des blocknamens drücke / und gib den namen des blocks ein, z b /verticalsplit , wodurch der gewünschte block herausgefiltert wird die dritte option ist die verwendung von klammern und des blocknamens – z b (api) – wodurch der api endpoint block hinzugefügt wird kopieren und einfügen die altmodischen copy‑paste‑brüder aber warum dieses thema behandeln? da der editor von archbee markdown unterstützt, kann es sein, dass du beim einfügen in diesem format die folgende meldung erhältst wir haben markdown‑inhalt in deiner zwischenablage erkannt versuchst du, markdown einzufügen? wenn du auf die abbrechen‑schaltfläche klickst, wird der inhalt nicht gerendert, und wenn du im dialogfeld auf ok klickst, konvertieren wir das markdown in archbee‑blöcke so hast du ein codebeispiel, das in archbee als code‑editor‑block gerendert wird markdown‑ oder word‑dateien importieren copy‑paste funktioniert einwandfrei, aber wenn du markdown‑ oder word‑dateien hast, warum sie nicht in einen space importieren? bevor du irgendwelche inhalte importierst, stelle sicher, dass du auf den space klickst, in den du die dateien importieren möchtest du hast einfach auf den dateityp geklickt, den du hast, und dir minuten des copy‑pastes aus anderen quellen gespart openapi/swagger‑dateien oder postman‑sammlungen importieren wenn es um die dokumentation von apis geht, haben sie mehrere optionen angenommen, sie verwenden den openapi standard (früher swagger) dies ermöglicht einen einfachen import und eine einfache synchronisierung der dateien nach dem import in archbee wird der inhalt in einem 3 spalten layout dargestellt, das eine leicht zu verwaltende dokumentation ermöglicht ein github repository synchronisieren es kommt vor, dass die dokumentation in einem github repository erstellt wird sie können weiterhin in github schreiben und das repository mit einem archbee space synchronisieren der vorteil besteht darin, dass sie diesen space auf ihrer eigenen domain veröffentlichen und weitere spaces mit zusätzlichen informationen wie api referenzen hinzufügen können die benutzerdefinierte domain und zugriffskontrolle einrichten bevor sie mit dem inhalt beginnen, machen sie einen kleinen schritt, der später einen unterschied machen wird richten sie ihre subdomain ein, um zugriff auf die preview und produktionsumgebungen zu haben gehen sie zur dokumentationsseite https //docs archbee com/hosting spaces on a custom domain und folgen sie den schritten, um ihre benutzerdefinierte domain hinzuzufügen mehrere optionen sind unter dem allgemein tab verfügbar – sie können die option indexierbar durch suchmaschinen (falls öffentlich) in denselben space einstellungen deaktivieren sie möchten dies oft aktiviert lassen, damit nutzer ihre seite auf der suchergebnisseite finden sie können zur option für öffentliche zugriffskontrolle gehen und eine der fünf optionen für mehr kontrolle auswählen keine macht genau das, was der name sagt, und behält ihre einstellungen bezüglich des öffentlichen spaces bei passwort legen sie ein space passwort fest jeder mit dem link und dem passwort kann den inhalt lesen gastkonten erstellen sie gastkonten jeder mit dem link und einem gastkonto kann den inhalt lesen gastkonten werden in archbee nicht als seats berechnet magic link sie geben bestimmte e mails ein oder setzen ganze domains auf die allowlist, und nutzer authentifizieren sich über einen link, den wir an ihre e mail adresse senden; jwt authentifizierung lesen sie die dokumentationsseite https //docs archbee io/authentication options? hstc=59513074 901e138137246d5bde4ccdbd22c4c426 1657529807386 1664186053341 1664199496535 118& hssc=59513074 7 1664199496535& hsfp=13091307 zur einrichtung es ist eine perfekte option, wenn sie nicht möchten, dass sich nutzer jedes mal anmelden müssen beginnen sie mit dem erstellen von seiten bevor sie irgendeine dokumentation schreiben, überlegen sie sich die hauptthemen, die sie behandeln werden diesmal könnten stift und papier hilfreich sein, um die struktur zu skizzieren erstellen sie als nächstes ein dokument, wandeln sie es in eine kategorie um und geben sie ihm einen namen sobald sie diese haben, können sie dokumente unter jeder kategorie hinzufügen beginnen sie mit einem dokument, das die wichtigsten dinge vorstellt, die ein benutzer auf der dokumentationsseite finden wird es muss nicht kompliziert sein; so haben wir es in unserem gemacht benutzer und entwicklerhandbuch erste schritte editor dokumente bereiche gehostete bereiche organisationen import & export integrationen anleitungen öffentliche api verschiedenes wenn sie beginnen, inhalte hinzuzufügen, ist es wichtig, einen workflow zu haben hier ist ein möglicher, aber den möchten sie vielleicht anpassen beginnen sie den entwurf in persönliche dokumente dies hilft ihnen, alles zu schreiben, was sie noch nicht mit dem team teilen möchten wenn sie bereit sind, verschieben sie es in den öffentlichen bereich pingen sie ein teammitglied an dass das dokument fertig ist und überprüft werden muss fügen sie gegebenenfalls inline kommentare hinzu, wo eingaben anderer benutzer erforderlich sind wenn sie mit den änderungen zufrieden sind, veröffentlichen sie zur vorschau um die staging seite zu sehen wenn alles gut aussieht, klicken sie auf für die produktionsumgebung veröffentlichen und geben sie bekannt, dass alles live ist die arbeit mit vorlagen erleichtert es beitragenden, mit dem schreiben von inhalten zu beginnen sie können eine reihe von vorlagen speichern, um die inhaltserstellung zu starten wenn sie inspiration benötigen, sehen sie beim erstellen eines neuen dokuments unten auf der seite eine schaltfläche namens mit einer vorlage beginnen um ihre eigenen vorlagen zu erstellen, gehen sie in der navigation auf der linken seite zu vorlagen und beginnen sie damit, dokumente mit der struktur zu erstellen, die ihre inhalte benötigen sie können auch die benutzerdefinierten blöcke einführen, die eine autorin oder ein autor verwenden wird, oder beispiele aus anderen quellen hinzufügen permalinks und seo‑einstellungen diese optionen befinden sich auf dokumentebene klicke also auf die drei punkte ⋮ oben rechts und wähle seo meta controls füge einen passenden titel hinzu, ändere die url , schreibe eine meta‑beschreibung oder lade ein bild hoch für vorschaubilder gestalten und personalisieren sie ihre dokumentations website im reiter darstellung finden sie die branding optionen wie akzentfarbe , logo , und favicon , zusammen mit weiteren optionen für die vorlage erstellen sie ein navigationsmenü mit mehreren produkten oder produktversionen je nach art der produkte oder dienstleistungen möchten sie möglicherweise unterschiedliche space url pfade haben sie können einen space als primäre dokumentation verwenden und verschiedene spaces für andere produkte oder sogar deren versionen erstellen es gibt eine abkürzung! sie können einen klon eines beliebigen space erstellen, wenn die änderungen inkrementell sind dies hilft ihnen, die struktur beizubehalten und die änderungen für die neue version vorzunehmen wenn sie also versionierung und mehrere produkte benötigen, verwenden sie verschiedene spaces und ergänzen sie diese mit dem entsprechenden pfad oder der benutzerdefinierten domain gehe zu space links https //docs archbee com/space links und beginne mit dem erstellen deiner navigation erstelle eine landingpage das hauptziel der startseite besteht darin, dem besucher zu helfen, zur nächsten seite zu gelangen eine landingpage für deine dokumentations website zu erstellen, muss nicht dieselben anforderungen wie bei einer präsentations website erfüllen die erste dokumentenseite ist wichtig, um dein produkt oder deine dienstleistung den nutzern vorzustellen daher zahlt es sich aus, sie kurz zu halten und klare erwartungen zu setzen sie können die funktion benutzerdefinierte landingpage https //docs archbee io/custom landing page? hstc=59513074 901e138137246d5bde4ccdbd22c4c426 1657529807386 1664186053341 1664199496535 118& hssc=59513074 7 1664199496535& hsfp=13091307 verwenden und ihr eigenes html hinzufügen, um mehr kontrolle über die erste seite zu erhalten es gibt viele optionen zur inspiration, und wenn sie das aussehen und gefühl der ersten seite ändern möchten, ist dies ihre möglichkeit so hat einer unserer kunden seine startseite für seine hilfeseite gestaltet benutzerdefinierten code hinzufügen verwenden sie benutzerdefiniertes css https //docs archbee io/custom css? hstc=59513074 901e138137246d5bde4ccdbd22c4c426 1657529807386 1664186053341 1664199496535 118& hssc=59513074 7 1664199496535& hsfp=13091307 wenn sie ihrer dokumentationsseite ihren eigenen \<font color="#a855f7">touch\</font> hinzufügen möchten wenn sie mit css klassen vertraut sind, finden sie einige ausgangspunkte – und sie können sie gezielt ansprechen