JohnSundell / Publishers, Hacker News

"ingredients (************************************,                         .forEach (item.****************** (metadata) .

**************** (text)  (($ 0) ))                         }                     ),                     .p  ()                         **************************************** (This will take around
,                         ************************************** (************************************  (Int) *********************************** () item.metadata****************************** (preparationTime) **********************************/
**********************************************************************************************************************)  () **********************************
),                         ************************************************ (minutes to prepare)  "                    ),                     .contentBody  (item.****************** (body) )                 )             )         }          ...      } }
Above we're able to access both built-in item properties, and the custom metadata properties that we defined earlier as part of our website's  (ItemMetadata)  struct, all in a way that retains full type safety.
More thorough documentation on how to build Publish themes, and some of the recommended best practices for doing so, will be added shortly.
************************************************************************************  Building plugins******************
Publishers also supports plugins, which can be used to share setup code between various projects, or to extend Publishers’s built-in functionality in various ways. Just like publishing steps, plugins perform their work by modifying the current  (PublishingContext)  - for example by adding files or folders, by mutating the website's existing content, or by adding Markdown parsing modifiers.
Here’s an example of a plugin that ensures that all of a website’s items have tags:
(extension************************  (Plugin)  {     static  (********************************** (var)  ensureAllItemsAreTagged:  (************************************ (Self)  {         Plugin  (************** (name) :********************** Ensure that all items are tagged
{contextin               let  allItems************** (=************************************ (context.) ********************************** (sections) *********************************************************** (flatMap) ********************************** ({********************************** ($ 0) ******************************************************************** items**********************}              for  item ******************************** (in)  allItems {                 guard  (**********************************!  item.tags (************************************. ********************************** (isEmpty) ***********************************else  {                      throw
**************************  PublishingError
(                          path
**************************: item. ****************************** (path) ,                         infoMessage (************************************: " (Item has no tags) ************************************  (**************************************                     )                 }             }         }     } }
Plugins are then installed by adding the  (installPlugin)  step to any publishing pipeline:
try  (************************************** DeliciousRecipes  ().**************:
For a real-world example of a Publish plugin, check out the  the official Splash plugin, which makes it really easy to integrate the  (Splash syntax highlighter) **************** with Publishers.
********************************************** ********************************Installation********************
Publish is distributed using theSwift Package Manager. To install it into a project, add it as a dependency within your  (Package.swift)  manifest:
let  (package) ********************************** (= (Package) *********************************** ()      ...      dependencies:  [        .package(url:"https://github.com/johnsundell/publish.git",from:"0.1.0")    ],      ...
Then import Publishers wherever you’d like to use it:
For more information on how to use the Swift Package Manager, check out  this article
, orits official documentation.
Publishers also ships with a command line tool that makes it easy to set up new website projects, and to generate and deploy existing ones. To install that command line tool, simply runmakewithin a local copy of the Publish repo:
$ git clone https://github.com/JohnSundell/Publish.git $ cd Publish $ make
Then run  (publish help)  for instructions on how to use it.
************************************************
****************Running and deploying
**************************
Since all Publishers websites are implemented as Swift packages, they can be generated simply by opening up a website's package in Xcode (by opening its  Package.swift  (file), and then running it using theProduct>Run
****************************** (command (or**************************** R   R. **************
Publishers can also facilitate the deployment of websites to external servers through its  (DeploymentMethod) **************************************** API, and ships with built-in implementations for Git and GitHub-based deployments. To define a deployment method for a website, add thedeploy  step to your publishing pipeline:
try  (************************************** DeliciousRecipes  ().**************:
**************
Even when added to a pipeline, deployment steps are disabled by default, and are only executed when the  - deploy  command line flag was passed (which can be added through Xcode's  (Product>Scheme>Edit Scheme ...
******************************** (menu), or by running the command line tool using  publish deploy
Publishers can also start a  (localhost)  web server for local testing and development, by using the  (publish run)  command.
**************************************************
**************************
To quickly get started with Publish, install the command line tool by first cloning this repository, and then run  make  within the cloned folder:
$ git clone https://github.com/JohnSundell/Publish.git $ cd Publish $ make
Then, create a new folder for your new website project and simply run  (publish new) ****************************************** within it to get started:
****************************** $ mkdir MyWebsite $ cd MyWebsite $ publish new
Finally, run  (open Package.swift)  to open up the project in Xcode to start building your new website.
**************************************************
******************
Publish was first and foremost designed to be a powerful and heavily customizable tool for building static websites in Swift - starting with  (Swift by Sundell, a website which has over 300 individual pages and a pipeline consisting of over  publishing steps.
While the goal is definitely also to make Publish as accessible and easy to use as possible, it will most likely keep being a quite low-level tool that favors code-level control over file system configuration files, and customizability over strongly held conventions.
The main trade-off of that design is that Publishers will likely have a steeper learning curve than most other static site generators, but hopefully it'll also offer a much greater degree of power, flexibility and type safety as a result. Over time, and with the community's help, we should be able to make that learning curve much less steep though - through much more thorough documentation and examples, and through shared tools and convenience APIs.
Publishers was also designed with code reuse in mind, and hopefully a much larger selection of themes, tools, plugins and other extensions will be developed by the community over time.
****************************************************
Contributions and support
Publishers is developed completely in the open, and your contributions are more than welcome.
Before you start using Publish in any of your projects, it's highly recommended that you spend a few minutes familiarizing yourself with its documentation and internal implementation, so that you'll be ready to tackle any issues or edge cases that you might encounter.
Since this is a very young project, it’s likely to have many limitations and missing features, which is something that can really only be discovered and addressed as more people start using it. While Publish is used in production to build all ofSwift by Sundell
, it's recommended that you first try it out for your specific use case, to make sure it supports the features that you need.
This project does not come with GitHub Issues-based support, and users are instead encouraged to become active participants in its continued development - by fixing any bugs that they encounter, or by improving the documentation wherever it's found to be lacking.
If you wish to make a change,  (open a Pull Request- even if it just contains a draft of the changes you're planning, or a test that reproduces an issue - and we can discuss it further from there.
Hope you’ll enjoy using Publish!  
(****************************************************(********************************************** (Read More) **************
(**********************************************************