Hagerstown, IN Comprehensive Plan
The new version of the Hagerstown, IN Comprehensive Plan. This project builds a static website with live search and a printable version of the full report.
This project requires
node. Make sure you have it
The generated site will reside in
The Comprehensive Plan consists of content written in Markdown, layouts which structure the content into an HTML page, and static assets (such as stylesheets, images and scripts).
For those wanting to edit the main content of the report from your browser, go to the content folder and click on the Markdown file you wish to edit. Once you've opened the file, click the Edit button in the toolbar to make changes. As stated before, the pages are written in a language called Markdown, which is a simplified version of HTML. Here is a good syntax reference. And remember, regular HTML is also valid Markdown.
Once finished editing, scroll to the bottom of the page and add a note explaining the amendments you made in the text box labeled Extended description: (optional), and then click the Commit Changes button.
Tweaking the core should be pretty straightforward too. The build system is
comprised of the
build.js script and the
/lib directory. Feel free to poke
around to see whats happening.
Content, or sections and subsections, are located in
section directory (i.e.
01-introduction) must be prepended with a zero-based
number representing the section's order within the document. The table of
contents is generated dynamically based off of these numbers.
Within each section directory there must be an
index.md and subsection files
named in a similar fashion:
Each Markdown file must start with a level 1 heading:
# Hello World Welcome to the section.
Layouts are located in
/layouts and are rendered using
EJS. There are two main layouts:
full-report (for printing the whole document), and a number
of includes located in
All static assets that don't require preprocessing (stylesheets, images,
scripts, etc.), reside in
/public and are copied over to the
directory when generating the site.
Publishing is as easy as building:
If you want to change the publish directory or host, just edit the
rule in the
For questions, concerns, amendments, etc., please contact Bob Warner, Town Manager firstname.lastname@example.org.
The MIT License (MIT)
Copyright (c) 2013-2014 Hagerstown, IN
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.