https://github.com/hugoarregui/awful-blog

A blog egg for Awful
https://github.com/hugoarregui/awful-blog

Last synced: about 2 months ago
JSON representation

A blog egg for Awful

• Host: GitHub
• URL: https://github.com/hugoarregui/awful-blog
• Owner: hugoArregui
• Created: 2013-07-07T01:25:57.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-08-28T23:35:37.000Z (over 8 years ago)
• Last Synced: 2023-04-06T00:32:11.632Z (over 1 year ago)
• Language: HTML
• Size: 32.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# awful-blog 

A blog egg for Awful. A blog is a just a collection of entries. A new entry can be created using the make-entry procedure:

	[procedure] (make-entry (title resource #!key url tags type extra))

-  title: entry title

-  resource: if type == redirect, resource is the redirect url,

   otherwise it should point to a file.

-  url: url in which the entry will be mounted

-  tags: entry tags (usually, a list of symbols)

-  type: types supported by default are: text, markdown, html, redirect, shtml

-  extra: a list extra data

## Index

A very common use case (for me at least) is to define a scm file with an

"index", that is: a scheme file where the entries are statically defined.

There is a syntax sugar to do that:

    [macro] (branch ((entry title:  url:  resource:  | branch ) ...)

                    [base-dir: ] [base-url: ] [tags:  type.

####  entry->sxml 

    [parameter] entry->sxml

entry->sxml conversion procedure, default: entry->sxml/default 

### Procedures

#### make-entry

	[procedure] (make-entry (title resource #!key url tags type extra))

Creates a new entry

#### define-entry-page 

    [procedure] (define-entry-page mount-url entry)

Defines an awful page from an entry. 

#### filter-entries-by-tag

    [procedure] (filter-entries-by-tag entries tags)

#### index-url 

    [procedure] (index-url mount-url entry)

Returns the entry url at which the index should point to.

#### text-entry->sxml 

    [procedure] (text-entry->sxml entry)

#### markdown-entry->sxml 

    [procedure] (markdown-entry->sxml entry)

#### entry->sxml/default 

    [procedure] (entry->sxml/default entry)

    

#### html-entry->sxml

    [procedure] (html-entry->sxml entry)

#### shtml-entry->sxml

    [procedure] (shtml-entry->sxml entry)

#### tsv->sxml

    [procedure] (tsv->sxml entry)

### Macros

#### branch

    [macro] (branch ((entry title:  url:  resource:  | branch ) ...)

                    [base-dir: ] [base-url: ] [tags: