Skip to content
This repository has been archived by the owner on Aug 22, 2022. It is now read-only.

bouncepaw/mycomarkup

Repository files navigation

Mycomarkup

godocs.io

⚠️ The development takes place on SourceHut!

Mycomarkup is a markup language designed to be used in Mycorrhiza Wiki. This project is both a library for the wiki engine and a command-line tool for processing Mycomarkup files in other projects.

See the Mycorrhiza docs on the markup language itself. The rest of the document provides documentation on the library and the command only.

Running

Usage of mycomarkup:
  -file-name string
        File with mycomarkup. (default "/dev/stdin")
  -hypha-name string
        Set hypha name. Relative links depend on it.

Set the parameters and run the program. The output will be written to stdout. The output is a poorly-formatted HTML code. In the future, more front-ends will be available.

Please note that transclusion is not supported in CLI.

Embedding

Mycomarkup provides an API for Go projects. Consult the docs and Mycorrhiza Wiki source code for inspiration.

Contributing

...is on SourceHut.