Läsa och hitta

Temat är ett lugnt dokumentationstema i stil med en referensmanual: meny till vänster, text i mitten och innehållsförteckning till höger. Inget laddas från tredje part i läsarens webbläsare, inte heller typsnitt.

Navigering

• Sidomeny, toppmeny med mega-meny och brödsmulor.
• Föregående/nästa längst ner på sidan.
• Innehållsförteckning som följer med när man rullar.
• Om sajten har slagit på det kan sidomenyn minimeras till en smal rad ikoner med knappen överst i menyn, och dess bredd dras med kanten mot innehållet (dubbelklick återställer). Valet sparas i webbläsaren. Finns bara på stora skärmar.

Byta sajt

Om sajtväljaren är påslagen finns en kompass i headern, bredvid förstoringsglaset. Den listar dokumentationerna (sajterna) och tar läsaren till startsidan i den som väljs.

• Läsaren ser bara sajter den får läsa.
• Har sajterna taggar grupperas de per tagg.
• Med många sajter finns ett sökfält överst i menyn. Det söker också i taggarna.

Se Sajter.

Sök

Cmd/Ctrl+K, eller förstoringsglaset i headern. Sökningen görs i webbläsaren och hittar bara det läsaren får se, i den egna sajten. De senaste sökningarna visas när sökfältet är tomt. En stor sajt kan låta servern söka i stället; sökrutan ser likadan ut (se Sökning på servern).

Den som förvaltar eller redigerar flera sajter kan få valet Mina sajter i sökrutan och söka i alla sina sajter på en gång. Members söker alltid i en sajt (se Sökning över sajter).

Taggar

Om taggar är påslagna står sidans taggar under titeln. Ett klick på en tagg visar alla sidor med den. I sökrutan filtrerar tag:namn på en tagg. Se Taggar.

Utskrift och export

Utskrift har en egen layout, alltid ljus, med sajtens logga (eller namnet) uppe till vänster. Word-filen har ingen logga. Menyn ⋮ vid sidans titel har också:

• kopiera eller ladda ner sidan som Markdown;
• Word-export av sidan;
• export av en hel gren (sidan med undersidor) som Markdown, utskrift eller Word, om det är påslaget.

Sidan som Markdown och llms.txt

Varje sida finns också som ren text i Markdown. Det är till för program och AI-assistenter som läser dokumentationen utan webbläsare.

• Var: lägg till .md efter sidans adress, till exempel /guider/installation.md. Startsidan är /index.md.
• Vad: sidans titel, beskrivning och text, utan meny och sidfot. Sist står länkar till sidan ovanför, föregående och nästa sida och undersidorna.
• llms.txt: /llms.txt i sajtens rot listar sajtens sidor med länkar till deras Markdown. En AI-assistent kan börja där.
• Vem ser vad: samma som på sidan. En skyddad sida kräver inloggning, och den som inte får läsa den får svaret Not Found. Den finns då inte heller i listorna.
• Versioner: llms.txt listar bara den aktuella versionen.
• Den som förvaltar sajten stänger av det med inställningen Download as Markdown. Då stängs knappen, adressen och llms.txt av tillsammans.

Filer

Bilder och länkade filer öppnas i en dialog, där man kan bläddra genom allt på sidan: bilder, PDF, video, ljud och Word-, PowerPoint- och Excel-filer.

Versioner

Om versioner är påslagna kan ett område, till exempel en produkt, ha flera versioner. Läsaren byter version i headern, och gamla versioner får en banner som länkar till den aktuella.

• En version kan ha en status: beta (en förhandsversion) eller utfasad (stöds inte längre). Statusen syns som en bricka i versionsväljaren och vid sökträffarna, och som en banner i egen färg, också om versionen är den aktuella.
• En sida som kopieras eller laddas ner som Markdown får versionen i titeln och filnamnet, till exempel Installation (Produkt 1.0).
• Sökmotorer leds från en sida i en äldre version till samma sida i den aktuella. En sida som bara finns i en äldre version hålls utanför sökmotorerna.

Skyddade sidor

Sidor läsaren inte får se syns inte i menyer, sök eller export. Se Åtkomst.