The parse-front-matter Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The parse-front-matter Reference Manual

This is the parse-front-matter Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:28:03 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

parse-front-matter

A front matter parser.

Usage

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 parse-front-matter

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

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

Description

Parse front matter.

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

Source

parse-front-matter.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 parse-front-matter/src

Parent

parse-front-matter (system)

Location

src/

Component

parse-front-matter.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 parse-front-matter.asd

Location

parse-front-matter.asd

Systems

parse-front-matter (system)


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/parse-front-matter.lisp

Packages

parse-front-matter

Exported Definitions

parse (function)

Internal Definitions

+front-matter-regex+ (special variable)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 parse-front-matter

The front matter parsing package.

Source

parse-front-matter.lisp (file)

Use List

common-lisp

Exported Definitions

parse (function)

Internal Definitions

+front-matter-regex+ (special variable)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 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 (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: +front-matter-regex+
Package

parse-front-matter

Source

parse-front-matter.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, parse-front-matter.asd: The parse-front-matter<dot>asd file
File, Lisp, parse-front-matter/src/parse-front-matter.lisp: The parse-front-matter/src/parse-front-matter<dot>lisp file

L
Lisp File, parse-front-matter.asd: The parse-front-matter<dot>asd file
Lisp File, parse-front-matter/src/parse-front-matter.lisp: The parse-front-matter/src/parse-front-matter<dot>lisp file

M
Module, parse-front-matter/src: The parse-front-matter/src module

P
parse-front-matter.asd: The parse-front-matter<dot>asd file
parse-front-matter/src: The parse-front-matter/src module
parse-front-matter/src/parse-front-matter.lisp: The parse-front-matter/src/parse-front-matter<dot>lisp file

Jump to:   F   L   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   P  
Index Entry  Section

F
Function, parse: Exported functions

P
parse: Exported functions

Jump to:   F   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

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

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

Jump to:   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, parse-front-matter: The parse-front-matter package
parse-front-matter: The parse-front-matter system
parse-front-matter: The parse-front-matter package

S
System, parse-front-matter: The parse-front-matter system

Jump to:   P   S