Documentació

unaltraweb

Documentació de referència i exemples reals d'unaltraweb.

unaltraweb

unaltraweb és una plataforma Jekyll reutilitzable per a webs estàtiques acadèmiques, projectes de recerca, cursos, programari, manuals i documentació.

El nom ve de l’expressió catalana una altra web: una altra web. Resumeix una necessitat habitual en el treball acadèmic: els membres del grup sovint necessiten una web més per a un curs, un projecte, un perfil personal, un manual o un espai públic de documentació.

El sistema redueix manteniment duplicat centralitzant l’estil visual i les funcionalitats principals en una plataforma compartida. Llistats bibliogràfics, diagrames, figures, taules, resultats de recerca, navegació multilingüe i barres laterals de documentació es mantenen una vegada i es reutilitzen en webs personals, webs de projecte, materials docents i documentació tècnica.

Usa aquest portal per entendre el model de contingut reutilitzable, triar el perfil adequat, executar el flux local amb Docker i documentar la sintaxi que va més enllà del Markdown estàndard.

Repositoris

Core: dosquartsdedocs/unaltraweb.
Starter i integració: dosquartsdedocs/unaltraweb-template.

Origen

unaltraweb va començar a partir del tema Jekyll obert al-folio i s’està refactoritzant com a nucli reutilitzable propi per als llocs de dosquartsdedocs.

Taula de continguts

Taula de continguts

Start Here

Choose Your unaltraweb Workflow Create and edit an unaltraweb site through GitHub or locally with Docker. Llegeix més

Publish With GitHub

Use Reusable GitHub Workflows GitHub Actions workflows provided by the unaltraweb core. Llegeix més

Work Locally

Tools For Local Work What users and maintainers need to work with unaltraweb. Llegeix més Run And Preview A Site How to create, edit, preview and publish unaltraweb sites. Llegeix més Jekyll Basics For Child Sites The minimum Jekyll concepts needed to edit an unaltraweb site safely. Llegeix més Use The Docker Image Runtime image used by local unaltraweb workflows. Llegeix més

Build A Site

Create Pages, Collections, And Navigation How editable content becomes navigation and rendered pages. Llegeix més Choose A Site Profile Prepared website families supported by unaltraweb. Llegeix més Build A Personal Site With unaltreselfie Personal academic and professional sites. Llegeix més Build A Project Site With unaltreprojecte Research project and infrastructure sites. Llegeix més Build A Manual With unaltremanual Manuals, courses and book-like teaching sites. Llegeix més Build A Documentation Portal With unaltredocs Technical documentation portals. Llegeix més Check Profile Features Before Publishing What to check before choosing and publishing a profile. Llegeix més

Design And Customize

Write Content With Markdown Extensions unaltraweb syntax beyond standard Markdown. Llegeix més Theme And Visual Design Theme modes, local style overrides and JavaScript integration in unaltraweb. Llegeix més Customize A Child Site Local customization points for unaltraweb child sites. Llegeix més Feature Reference Map of reusable unaltraweb features, syntax and examples. Llegeix més

Contribute

Understand Core And Template Roles Why unaltraweb-template is the primary integration demo. Llegeix més

Core Development

Develop The Core Safe development and verification workflow for unaltraweb. Llegeix més Understand The Distribution Model Core/template split and update model for unaltraweb. Llegeix més Maintain The Metrics Pipeline Static bibliometric metrics workflow for unaltraweb sites. Llegeix més

Reference

Front Matter Reference Common front matter keys used by unaltraweb pages and collections. Llegeix més Data Files Reference Structured data files commonly used by unaltraweb child sites. Llegeix més Frequently Asked Questions Common questions about unaltraweb sites. Llegeix més