asset: Add brief documentation.
* haunt/asset.scm: Add introductory comment. * README.md (Example Configuration): Add 'directory-assets' example.
This commit is contained in:
		@@ -23,7 +23,8 @@ Example Configuration
 | 
				
			|||||||
(use-modules (haunt site)
 | 
					(use-modules (haunt site)
 | 
				
			||||||
             (haunt reader)
 | 
					             (haunt reader)
 | 
				
			||||||
             (haunt builder blog)
 | 
					             (haunt builder blog)
 | 
				
			||||||
             (haunt builder atom))
 | 
					             (haunt builder atom)
 | 
				
			||||||
 | 
					             (haunt builder assets))
 | 
				
			||||||
 | 
					
 | 
				
			||||||
(site #:title "Built with Guile"
 | 
					(site #:title "Built with Guile"
 | 
				
			||||||
      #:domain "example.com"
 | 
					      #:domain "example.com"
 | 
				
			||||||
@@ -33,7 +34,8 @@ Example Configuration
 | 
				
			|||||||
      #:readers (list sxml-reader html-reader)
 | 
					      #:readers (list sxml-reader html-reader)
 | 
				
			||||||
      #:builders (list (blog)
 | 
					      #:builders (list (blog)
 | 
				
			||||||
                       (atom-feed)
 | 
					                       (atom-feed)
 | 
				
			||||||
                       (atom-feeds-by-tag)))
 | 
					                       (atom-feeds-by-tag)
 | 
				
			||||||
 | 
					                       (static-directory "images"))
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Usage
 | 
					Usage
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -1,5 +1,6 @@
 | 
				
			|||||||
(use-modules (haunt site)
 | 
					(use-modules (haunt site)
 | 
				
			||||||
             (haunt reader)
 | 
					             (haunt reader)
 | 
				
			||||||
 | 
					             (haunt asset)
 | 
				
			||||||
             (haunt builder blog)
 | 
					             (haunt builder blog)
 | 
				
			||||||
             (haunt builder atom)
 | 
					             (haunt builder atom)
 | 
				
			||||||
             (srfi srfi-19))
 | 
					             (srfi srfi-19))
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -35,6 +35,11 @@
 | 
				
			|||||||
            install-asset
 | 
					            install-asset
 | 
				
			||||||
            directory-assets))
 | 
					            directory-assets))
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					;; Assets are static files that are copied verbatim from a site's
 | 
				
			||||||
 | 
					;; source directory to the target output directory, such as images,
 | 
				
			||||||
 | 
					;; CSS, and JavaScript files.  The 'source' and 'target' fields are
 | 
				
			||||||
 | 
					;; file names that are relative to a source and target directory,
 | 
				
			||||||
 | 
					;; respectively.
 | 
				
			||||||
(define-record-type <asset>
 | 
					(define-record-type <asset>
 | 
				
			||||||
  (make-asset source target)
 | 
					  (make-asset source target)
 | 
				
			||||||
  asset?
 | 
					  asset?
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user