https://github.com/nichtich/xanadoc-demo

Minimal hypertext system
https://github.com/nichtich/xanadoc-demo

Last synced: 22 days ago
JSON representation

Minimal hypertext system

• Host: GitHub
• URL: https://github.com/nichtich/xanadoc-demo
• Owner: nichtich
• License: unlicense
• Created: 2022-09-28T07:57:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-28T07:58:56.000Z (over 2 years ago)
• Last Synced: 2024-10-30T16:24:35.653Z (2 months ago)
• Language: Perl
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hypertext system based on YAML Xanadoc documents

This repository implements a minimal hypertext system following conventions laid out at  and .

## Installation

Source code is available from .

    git clone https://github.com/nichtich/xanadoc-demo.git

    cd xanadoc-demo

The system is implemented in Perl. Run

    cpanm --installdeps .

to install required Perl modules.

## Usage

Execute `./xanadoc` with a Xanadoc file as first argument, e.g.

    ./xanadoc example.yml

The default output is plain text with transcluded document selections

marked by `[[` and `]]`. More sophisticated output formats with support

of links are yet to be implemented.

Xanadoc file format is based on YAML (see `example.yml`).

## License

Use as you like but proper citation is welcome!