Welcome to the documentation for Astrality

Table of Contents

Documentation

• Astrality - A Dynamic Configuration File Manager
  • What does it do?
  • Getting started
• Configuration
  • The Astrality configuration directory
  • The Astrality configuration files
  • The configuration file syntax
  • Astrality configuration options
  • Where to go from here
• Templating
  • Template files
  • Context
  • Advanced templating
  • How to compile templates
• Modules
  • What are modules?
  • How to define modules
  • Action blocks
  • Actions
  • Global configuration options for modules
  • Module subdirectories
  • GitHub modules
• Event listeners
  • What are event listeners?
  • What are event listeners used for?
  • How to set a module event listener
  • Events
  • Event listener types
• Tutorial
  • Managing dotfiles with templates
  • A module using events
• Example configuration
• Tips and Tricks
  • Configuration of other applications

Codebase

• Changelog
  • [1.0.0] - 2018-05-24
• How to contribute
  • Bug reports and feature requests
  • Improving the documentation
  • Contributing code
• API documentation
  • The structure of the code base
  • Modules

Legalese

• Attributions
  • Inspirations for themes
• License

External resources

• Source code on GitHub
• YAML syntax documentation
• Jinja2 templating documentation