brennen
/
wrt
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 27 Wiki Activity
Almost-minimal filesystem based blog.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
438 Commits
1 Branch
2.2 MiB
Tree: v7.1.0
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'v7.1.0'
${ noResults }
wrt/README.md

97 lines
2.9 KiB
Raw Permalink Normal View History

replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
handle sites with an index file in the root - adds an example "flat" site with, for now, a single index in root for testing purposes - wrt-render-all handles default entry instead of just using "new" - EntryStore::all_renderable() correctly filters out paths ending in "/index" instead of "index", which if nothing else corrects a subtle bug that would have gotten in the way of naming something "windex" - WRT::handle() will return the contents of a root-level "index"
4 years ago
​
​
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
​
​
​
​
​
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
​
​
​
​
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
handle sites with an index file in the root - adds an example "flat" site with, for now, a single index in root for testing purposes - wrt-render-all handles default entry instead of just using "new" - EntryStore::all_renderable() correctly filters out paths ending in "/index" instead of "index", which if nothing else corrects a subtle bug that would have gotten in the way of naming something "windex" - WRT::handle() will return the contents of a root-level "index"
4 years ago
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
​
​
​
cache rendered html; extract titles; all as utf-8 This stashes the HTML version of every entry in memory and uses Mojo::DOM to extract headers from the markup for use as titles. Titles are displayed in $self->{page_navigation}, now available inside templates as ${page_navigation}. In order to keep Mojo::DOM from choking on other input, it uses the open pragma to open everything as UTF-8 by default, which also eliminates a whole class of character encoding bugs and removes some fiddling with Encode::decode() from feed_print(). This is all obviously a more memory-intensive, but caching the markup turns out to have the side effect of making it much faster to render even a large site, probably as much as anything because the HTML in question is only getting generated once per entry instead of (potentially) 2-3 times. This commit isn't very atomic. In the process of roughing it out and testing it, I made a small pile of minor but potentially breaking changes: - Removed entry_map from settings and hardcoded handling of various types of entry as some if-statements instead. - Removed embedded_perl flag in settings - was always turned on in practice, and wasn't very coherent since templating would have broken without it. - bin/wrt-display - now handles the "feed" alias correctly - EntryStore: now supports retrieving values for properties with prop_value() - this isn't currently used, but it seems like a reasonable extension of the property idea. - Added `wrt ls --with-titles`. - Added dependency versions to Build.PL. - Refactored Markup's line_parse() a little. - Refactored some tests to give cleaner / more useful output. - Renamed default template file to "default".
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
update changelog & do some pre-release tidying
4 years ago
replace README.pod with README.md; remove Travis link This no longer just duplicates the POD contents of lib/App/WRT.pm. Also gets rid of the Travis CI widget.
5 years ago
​
​
​
​
​
​
​
​
​
​
 
  1. wrt
  2. ===
  3. 

  4. wrt (WRiting Tool) is a static site / blog generator and some related
  5. utilities.
  6. 

  7. This project can be thought of as both a format for storing blog entries and
  8. other writing in folders and files, as well as the utilities for rendering them
  9. to a full-fledged web site.  It's particularly well-suited to collections of
  10. blog entries organized by date.
  11. 

  12. wrt can be found at:
  13. 

  14.   - [metacpan.org as App::WRT](https://metacpan.org/pod/App::WRT) - latest CPAN release
  15.   - https://code.p1k3.com/gitea/brennen/wrt - latest code
  16. 

  17. I have been using some version of this code to publish [p1k3][p1k3] since 2001,
  18. and have written [various posts about it][p1k3-wrt] over the years.
  19. 

  20. [p1k3]: https://p1k3.com/
  21. [p1k3-wrt]: https://p1k3.com/topics/wrt/
  22. 

  23. installation and use
  24. ====================
  25. 

  26. You'll need a Unix / Linux, and a relatively recent Perl installation.  In
  27. practice I know that Debian Jessie or later (or Ubuntu 16.04 or later) and Perl
  28. 5.26.1 work.
  29. 

  30. The short version, CPAN edition:
  31. 

  32. ```sh
  33. cpan -i App::WRT
  34. ```
  35. 

  36. The short version, git edition:
  37. 

  38. ```sh
  39. git clone https://code.p1k3.com/gitea/brennen/wrt.git
  40. cd wrt
  41. perl Build.PL
  42. ./Build installdeps
  43. ./Build test
  44. ./Build install
  45. ```
  46. 

  47. Starting a new site once installed:
  48. 

  49. ```sh
  50. # Set up some defaults:

  51. mkdir project && cd project
  52. wrt init
  53. 

  54. # Create an entry for January 1, 2019:

  55. mkdir -p archives/2019/1/
  56. nano archives/2019/1/1
  57. 

  58. # Publish HTML to project/public/

  59. wrt render-all
  60. ```
  61. 

  62. Please see the [App::WRT listing on MetaCPAN][mc] or the POD documentation in
  63. [lib/App/WRT.pm](lib/App/WRT.pm) in this repository for detailed instructions.
  64. 

  65. [mc]: https://metacpan.org/pod/App::WRT
  66. 

  67. security
  68. ========
  69. 

  70. A cautionary note that, since wrt templates and entries can contain embedded
  71. Perl, running this code against untrusted input is effectively the same as
  72. executing an arbitrary script.  There may be _other_ issues with running it
  73. against an untrusted archive (I make no promises) but it's probably not worth
  74. worrying about them in light of the `<perl>` feature.
  75. 

  76. This shouldn't worry you if you're generating a static site of your own.  Just
  77. don't (for example) create a service that uses it to publish sites for users
  78. you don't already trust to run code on your systems.
  79. 

  80. wrt-as-a-service might be something I explore in future, but it will need
  81. some tweaking first.
  82. 

  83. copying
  84. =======
  85. 

  86. wrt is copyright 2001-2020 Brennen Bearnes.
  87. 

  88. wrt is free software; you can redistribute it and/or modify it under the terms
  89. of the GNU General Public License as published by the Free Software Foundation;
  90. either version 2 of the License, or (at your option) any later version.
  91. 

  92. This program is distributed in the hope that it will be useful, but WITHOUT ANY
  93. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  94. PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  95. 

  96. You should have received a copy of the GNU General Public License
  97. along with this program.  If not, see http://www.gnu.org/licenses/