Einsatz

LFP Docs kann überall eingesetzt werden, wo das Hosting von statischen Inhalten möglich ist, sogar im Einsatz als lokale Wissensdatenbank!

Diese Seite setzt die folgenden Umstände voraus:

• npx lfpdocs init --add-scripts wurde gestartet und die entsprechenden Scriptbefehle sind in ./package.json abgelegt
• config.dir.input ist auf /docs gesetzt
• config.dir.output ist auf /_site gesetzt

Lokaler Test und Build

Folgende Befehle ausführen, um die Seite vor dem Einsatz zu testen:

# die Seite mittels des lokalen Servers überprüfen
npx lfpdocs dev
# die Seite lokal in das Output-Verzeichnis schreiben
npx lfpdocs build

Das build-Kommando schreibt die Seite standardmäßig in /_site, dieses Verhalten kann mit config.dir.output geändert werden.

Eine Base URL setzen

Falls die Seite von der Domain Root zugänglich sein soll, kann dieser Abschnitt übersprungen werden.

Andernfalls kann unter config.baseUrl eine Base URL gesetzt werden.

Ein Dokument, das mit dem Inputpfad /guide/get-started.md (relativ zu config.dir.input) abgelegt ist, wäre dann mit einer Base URL von https://example.org/docs unter https://example.org/docs/guide/get-started/ erreichbar.

Plattformanleitungen

Viele Anbieter bieten automatisierte Buildpipelines an, mit denen LFP Docs in der Regel kompatibel ist.

Codeberg

Diese Anleitung für Forgejo Actions ist ein hervorragender Startpunkt, um die Dokumentation unter codeberg.page zu hosten.

name: Publish
on:
  push:
jobs:
  publish:
    # für Informationen zu Runnern: https://codeberg.org/actions/meta
    runs-on: codeberg-tiny-lazy
    steps:
      - uses: actions/checkout@v5
      - run: npm i -D && npm run build:docs
      - uses: actions/git-pages@v2
        with:
          site: https://example.org/your/base-url # die eigene Projekt-URL angeben
          token: ${{ forge.token }}
          source: _site/  # hier `config.dir.output` angeben

GitHub Pages

Auch für GitHub ist der Einsatz eines Workflows (GitHub Action) empfohlen:

name: Deploy LFP Docs to Pages
on:
  # Runs on pushes targeting the `main` branch. Change if needed
  push:
    branches: [main]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write
concurrency:
  group: pages
  cancel-in-progress: false
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6
      - name: Setup Node
        uses: actions/setup-node@v6
        with:
          node-version: 26
          cache: npm
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npm run docs:build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: _site # change this to your config.dir.output
  deploy:
    environment:
      name: github-pages
      url: ${{steps.deployment.outputs.page_url}}
    needs: build
    runs-on: ubuntu-latest
    name: Deploy
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

Je nach individuellen Anforderungen kann die GitHub-eigene Dokumentation Hilfe bieten.

Netlify/Vercel/Cloudflare Pages/AWS Amplify/Render

1. Ein neues Projekt erstellen.
2. Einstellungen im Dashboard des Projekts vornehmen:
   • Build-Kommando: npm run docs:build
   • Output-Verzeichnis: _site
   • Node-Version: 22 (oder höher)

Das Projekt sollte jetzt gebaut werden, sobald der angegebene Branch gepusht oder ein anderweitig gesetzter Trigger aktiviert wird.