Skip to content

it-pal-net/palbook-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PalBook Library (RemoteBook)

This repository is the canonical RemoteBook that ships with PalBook by default.

It is all of these things at once:

  • A runnable standard library of playbooks (the primary artifact).
  • The executable specification for the PalBook playbook format and directives.
  • A best-practices template for how real teams should structure their own books.
  • The source for the public documentation site (Docusaurus), which always points back to the runnable playbooks in this repo.

How this repo is structured

Playbooks (books)

Runnable books live under:

  • books/

Each book is a folder containing one or more .sh playbooks.

PalBook directives are comments starting with #@. Shells ignore them; PalBook uses them to provide structure, metadata, and execution controls.

Documentation site (Docusaurus)

Docs live under:

  • docs/ (a full Docusaurus project)

Docs pages do not duplicate the spec/examples. They link into the real playbooks in books/ and use #@doc directives to connect book/group/step UI elements to the right docs page.

Maintainer utilities

  • dev/: helper playbooks for maintainers (build docs, validate conventions, etc.)

Recommended reading order

  • books/getting-started/
  • books/basic-concepts/
  • books/directives/
  • books/examples/
  • books/advanced/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages