Roadmap

Upcoming

v0.5.0-alpha

• Docs for custom assets and templates
• Custom kind for connections
• Hide tree leaves from the top level
• Fix anchors containing / and # considered node IDs
• Fix PreFormat blocks rendering HTML tags

v0.6.0-alpha

• Custom header include

v0.7.0-alpha

• Frontmatter format
• Multi-file graphs

v0.8.0-alpha

• Full-text search

Backlog

These changes are planned, but have not been assigned to an upcoming release yet.

Syntax

• Improve nested formatting
• Invert where redirects are set
• Special sections
  • Top-bound
    • Top-bound is not included in the summary (tooltip)
    • Sections
      • Definition (implies metadata has_definition)
      • See also (implies a kind of connection, e.g. related)
      • Not to be confused with (implies a kind of connection)
  • Contrast with (implies a kind of connection)
  • Example (implies metadata has_example)
  • Bottom-bound
    • References/influences (implies metadata has_references)
      • Aggregated from the full text content

Metrics

• Most linked to nodes
• Most linked from nodes
• Most linked

Rendering

• Sorting of tree, index list and drop-down navigation
  • Alphabetic
  • By most linked to
  • By most linked
• Tree
  • Branch deeper
• Customization
  • Custom assets (favicon, CSS)
    • Drop all hardcoded assets endpoints
  • Custom templates
    • user-supplied loading order (e.g. through filenames)
  • Themes
• Table of contents

Connections

• # syntax for header ID anchors
• Connection kinds
  • Mutual
  • Category <-> Membership
  • Opposite <-> Equivalent
  • Contrast <-> Similar
  • Cognate <-> Unrelated
  • Specialization <-> Generalization
  • Custom connection kinds
  • External anchors
• Suffix-aware anchors
  • Plural anchors (|node|s -> node)
  • Ignore trailing punctuation
  • Conjugation anchors (|will|ed -> will)
  • Configurable suffixes

I/O formats

Input

• Multi-graph

Output

• Add separate TOML endpoints for pre/postprocessed
• Render to filesystem
• Single-page rendering
• Consider printing parsing errors to console by default

Templating

• Simplify template code with includes, macros and custom functions
• Move compiled templates to a static ref
  • See: https://keats.github.io/tera/docs/#:~:text=only%20happen%20once
• Reduce whitespace
  • See: https://keats.github.io/tera/docs/#whitespace-control

Documentation

• Generate meta.config docs from JSON schema

Validation

• Finalize JSON schema
• Add CI step with taplo lint

Internals

• Assess Option return types that should be Result
• Replace CI tooling setup script with a nix shell

Performance

• Caching
• Reduce O(n) calls in the formats module

Done

Changelog

v0.4.0-alpha

• Embed assets and welcome graph into the binary
• Source custom templates and assets from ./templates and ./static/public