Module / Core

Marqua provides a lightweight core module with minimal features and dependencies that does not rely on platform-specific modules so that it could be used anywhere safely.

parse

Parse accepts a source string and returns a { body, metadata } structure. This function is mainly used to separate the front matter from the content or in this case body.

	

		

			Toggle
Numbering
			Copy
		
	

	
export function parse(source: string): {
	body: string;
	metadata: Record<string, any> & {
		readonly estimate: number;
		readonly table: MarquaTable[];
	};
};

If you need to read from a file or folder, use the compile and traverse functions from the /fs module.

construct

Where the metadata or front matter index gets constructed, it is used in the parse function.

	

		

			Toggle
Numbering
			Copy
		
	

	
type Primitives = null | boolean | string;
type ValueIndex = Primitives | Primitives[];
type FrontMatter = { [key: string]: ValueIndex | FrontMatter };

export function construct(raw: string): ValueIndex | FrontMatter;