Changeset 27180 in project


Ignore:
Timestamp:
08/04/12 00:22:25 (7 years ago)
Author:
Moritz Heidkamp
Message:

hyde: Update documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/hyde

    r25974 r27180  
    161161; {{hyde new <page-type> [<title> ...]}} : Creates a new page with the given page type and title. The page's filename will be inferred from the given title by downcasing it and replacing spaces with dashes.
    162162; {{hyde serve}} : Serves the current site with [[spiffy]], (re-)compiling the requested page on each request (useful for development). This command respects the {{-e}} option.
     163; {{hyde build [<prefix> ...]}} : Builds the current site. If prefixes are given then only paths having those prefixes will be built. This command respects the {{-e}} option.
    163164; {{hyde}} : Compiles the current site. This command respects the {{-e}} option.
    164165
     
    270271
    271272This feature has been added in version 0.12.
     273
     274
     275<parameter>(ignore-page? [predicate])</parameter>
     276
     277`predicate` is a procedure accepting a page; when it returns `#t` that
     278page will not be compiled to an output file (it can still be accessed
     279through `pages` though).
     280
     281This parameter has been added in version 0.16.
     282
    272283
    273284=== Helpers
     
    302313</enscript>
    303314
     315
     316<procedure>(pathify string)</procedure>
     317
     318Turn `string` into a URL friendly path name.
     319
     320Example:
     321
     322<enscript language="scheme">
     323(pathify "This is \"something\" nice.") ; => "this-is-something-nice"
     324</enscript>
     325
     326Exported since version 0.16.
     327
     328
     329<constant>sxml-conversion-rules</constant>
     330
     331The set of SXML conversion rules used for translating `sxml` pages.
     332
     333Exported since version 0.15.
     334
     335
    304336=== Available Bindings During Page Evaluation
    305337
     
    370402=== Change Log
    371403
     404; 0.16 ; Add `hyde build` command. Allow link-shortcuts to be procedures. Extract `pathify`. Use `big-chicken` module environment when possible. Fix issue in `hyde serve` with trailing slashes on paths (thanks John J Foerch for the patch). Add `ignore-page?`. Fix escaping issue in colorize-code (thanks Peter Bex for the patch). Add a link with relation `alternate` to the atom feed emitted by `hyde-atom`.
     405; 0.15 ; Add `hyde-atom` module for convenient generation of atom feeds from pages. Export {{sxml-conversion-rules}}
    372406; 0.14 : Some compatibility changes. Depend on Spiffy >= 4.9.
    373407; 0.13 : Update to scss 0.3. Make {{pages}} a parameter in {{page-eval-env}}.
Note: See TracChangeset for help on using the changeset viewer.