mycomarkup

package module
v2.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2021 License: Apache-2.0 Imports: 7 Imported by: 2

README

Mycomarkup

godocs.io

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.

Also see our kanban board and this hypha.

Running

Usage of mycomarkup:
  -filename 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

All pull requests are welcome. Feel free to open issues. Also, pay a visit to the Mycorrhiza Wiki Telegram chat. Also consider donating on Boosty.

Documentation

Overview

Package mycomarkup provides an API for processing Mycomarkup-formatted documents.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BlockToHTML

func BlockToHTML(block blocks.Block, counter *blocks.IDCounter) string

BlockToHTML turns the given block into HTML. It supports only a subset of Mycomarkup.

func BlockTree

func BlockTree(ctx mycocontext.Context, visitors ...func(block blocks.Block)) []blocks.Block

BlockTree returns a slice of blocks parsed from the Mycomarkup document contained in ctx.

Pass visitors. Visitors are functions (usually closures) that are called on every found block.

Visitors included with mycomarkup can be gotten from OpenGraphVisitors. More visitors coming soon.

func BlocksToHTML

func BlocksToHTML(_ mycocontext.Context, ast []blocks.Block) string

BlocksToHTML turns the blocks into their HTML representation.

Types

This section is empty.

Directories

Path Synopsis
Package blocks provides some of the Mycomarkup's blocks.
Package blocks provides some of the Mycomarkup's blocks.
cmd
Package globals provides global variables.
Package globals provides global variables.
Package links provides a data type for links.
Package links provides a data type for links.
Package mycocontext provides a wrapper over context.Context and some operations on the wrapper.
Package mycocontext provides a wrapper over context.Context and some operations on the wrapper.
Package parser turns the source text into a sequence of blocks.
Package parser turns the source text into a sequence of blocks.
Package tools provides visitors for external usage and will provide other tools one day.
Package tools provides visitors for external usage and will provide other tools one day.
Package util provides simple utility functions usable in all modules.
Package util provides simple utility functions usable in all modules.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL