https://github.com/germ/XanaDown

Xanadu Web Client
https://github.com/germ/XanaDown

Last synced: 3 days ago
JSON representation

Xanadu Web Client

• Host: GitHub
• URL: https://github.com/germ/XanaDown
• Owner: germ
• Created: 2019-06-25T07:16:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:54:37.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T05:11:46.077Z (3 months ago)
• Language: Perl
• Size: 54.8 MB
• Stars: 8
• Watchers: 5
• Forks: 1
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Xanadown

Manifesting XanaSpace via Markdown

# Installation/Build

Prerequisites: yarn, npm, gitfs

`

git clone https://github.com/germ/XanaDown.git

cd XanaDown

make

`

If everything goes well a folder named deploy will be generated. Run xanadoc-server and you're good to do. Alternatively you 

can just push the frontend and configure the endpoint to existing server. 

# Namespacing/Versioning

XanaDocs require versioning, without it transclusion doesn't work. For this we use gitfs and dynamically pull in repos as needed

to serve content and revision. The fuse mount point by default is docs/. See the gitfs for syncing tuning, as of now pushing is not

handled by the server. 

for example germ/x is mounted at docs/github.com/germ/x

# Todo

- Add a few themes

- Option to span webpages

- Add configuration for default to render and provide a editor page

- Last access time for pruning of unused docs

This is a rework of [wormwood](gitlab.com/krampus/wormwood) with the goal of simplifying many aspects and providing a working implementation. As such, the 'XanaDown' folder is provided for reference until a working prototype is complete

Shout out to Ted, you crazy bastard.