The parse-front-matter Reference Manual

This is the parse-front-matter Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:31:14 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 parse-front-matter

Parse front matter.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/eudoxia0/parse-front-matter

Source Control

(GIT https://github.com/eudoxia0/parse-front-matter.git)

Bug Tracker

https://github.com/eudoxia0/parse-front-matter/issues

License

MIT

Long Description

# parse-front-matter

A [front matter](https://jekyllrb.com/docs/frontmatter/) parser.

# Usage

“‘lisp
CL-USER> (ql:quickload :parse-front-matter)
To load "parse-front-matter":
Load 1 ASDF system:
parse-front-matter
; Loading "parse-front-matter" ..................................................
[package parse-front-matter]
(:PARSE-FRONT-MATTER)

CL-USER> (parse-front-matter:parse "—
a: b

My text")
"a: b"
"My text"
“‘

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependency

cl-ppcre (system).

Source

parse-front-matter.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 parse-front-matter/src

Source

parse-front-matter.asd.

Parent Component

parse-front-matter (system).

Child Component

parse-front-matter.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 parse-front-matter/parse-front-matter.asd

Source

parse-front-matter.asd.

Parent Component

parse-front-matter (system).

ASDF Systems

parse-front-matter.


4.1.2 parse-front-matter/src/parse-front-matter.lisp

Source

parse-front-matter.asd.

Parent Component

src (module).

Packages

parse-front-matter.

Public Interface

parse (function).

Internals

+front-matter-regex+ (special variable).


5 Packages

Packages are listed by definition order.


5.1 parse-front-matter

The front matter parsing package.

Source

parse-front-matter.lisp.

Use List

common-lisp.

Public Interface

parse (function).

Internals

+front-matter-regex+ (special variable).


6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Ordinary functions

Function: parse (string)

Parses front matter from a string, returning two values: the text of the front matter and the file’s content.

Package

parse-front-matter.

Source

parse-front-matter.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: +front-matter-regex+
Package

parse-front-matter.

Source

parse-front-matter.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   F   P  
Index Entry  Section

F
Function, parse: Public ordinary functions

P
parse: Public ordinary functions


A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+front-matter-regex+: Private special variables

S
Special Variable, +front-matter-regex+: Private special variables