sitepress-cli 2.0.0.beta1 → 2.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fc86e4655668df585ba97942fc28875c933b961e7954fdbc38f3756c33d26c1
-  data.tar.gz: 8ac1c2809c11a3b4323bcf3cad79e3745dbc737d40c5de6fb39f9c693e7e47ab
+  metadata.gz: a82f49b989bacd6a164a8731236b024e8077f2d0aedbbb6d820e458fa5c25d46
+  data.tar.gz: dadfe14d2356ce24be5a37162be5adb596b16d4feeef4d7389b6c32e9ffce024
 SHA512:
-  metadata.gz: 17a337157a7fc2d9fcc5d53d445b436457126648506a9206a6a70454d2a714e8c01e46a7783bafc4640362490d99823f5822da83177bd8df473d35fac57225dd
-  data.tar.gz: f87c82537beae5d3f181c1ea5c511e56c5088cdb6b40262fe71ab2ad5adc23ce2b1b51ded1ded31e88f8c62d60662993c810e1985d4c114814d7333a67488959
+  metadata.gz: 63232b800cead44c3c80a98b34a65907c98647ceea89147941c231117d3c1530e7b18735731defd1d7b3e0413625e55cf910bcbd11cdaf342c006e2d1ac99426
+  data.tar.gz: 61f98c78d9a4d962803d70793846cbeb5b293e861c1b67e39acbe07893d1bdeaa530b720b5e8edf9ace0dca68475bc42ec6d45c9895b903c2c40e6a69b74f3eb

data/lib/sitepress/cli.rb

@@ -1,5 +1,4 @@
 require "thor"
-require_relative "boot"
 
 module Sitepress
   # Command line interface for compiling Sitepress sites.
@@ -16,7 +15,7 @@ module Sitepress
     option :port, default: SERVER_DEFAULT_PORT, aliases: :p, type: :numeric
     desc "server", "Run preview server"
     def server
-      Sitepress::Server.initialize!
+      initialize!
       # This will use whatever server is found in the user's Gemfile.
       Rack::Server.start app: Sitepress::Server,
         Port: options.fetch("port"),
@@ -26,7 +25,7 @@ module Sitepress
     option :output_path, default: COMPILE_DEFAULT_TARGET_PATH, type: :string
     desc "compile", "Compile project into static pages"
     def compile
-      Sitepress::Server.initialize!
+      initialize!
       # Sprockets compilation
       logger.info "Sitepress compiling assets"
       sprockets_manifest(target_path: options.fetch("output_path")).compile precompile_assets
@@ -37,13 +36,17 @@ module Sitepress
 
     desc "console", "Interactive project shell"
     def console
-      Sitepress::Server.initialize!
+      initialize!
       # Start's an interactive console.
       REPL.new(context: configuration).start
     end
 
     desc "new PATH", "Create new project at PATH"
     def new(target)
+      # Peg the generated site to roughly the released version.
+      *segments, _ = Gem::Version.new(Sitepress::VERSION).segments
+      @target_sitepress_version = segments.join(".")
+
       inside target do
         directory self.class.source_root, "."
         run "bundle install"
@@ -52,7 +55,7 @@ module Sitepress
 
     desc "version", "Show version"
     def version
-      say "Sitepress #{Sitepress::VERSION}"
+      say Sitepress::VERSION
     end
 
     private
@@ -82,5 +85,10 @@ module Sitepress
     def precompile_assets
       rails.config.assets.precompile
     end
+
+    def initialize!
+      require_relative "boot"
+      Sitepress::Server.initialize!
+    end
   end
 end

data/templates/default/{Gemfile → Gemfile.tt}

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 
 # Stand-alone Sitepress server and compiler.
-gem "sitepress"
+gem "sitepress", "~> <%= @target_sitepress_version %>"
 
 # Server used for the Sitepress preview server.
 gem "webrick"

data/templates/default/README.md

@@ -0,0 +1,73 @@
+# Getting started
+
+Welcome to your new Sitepress site! If you know Rails, you'll feel right at home in Sitepress because it's built on top of Rails. There's a few things you'll need to know to get around:
+
+## Starting the preview server
+
+First thing you'll want to do is start the preview server:
+
+```sh
+$ sitepress server
+```
+
+Then open http://127.0.0.1:8080 and you'll see the welcome page.
+
+## Layouts
+
+To specify a layout for a page, add a `layout` key to the pages frontmatter. For example, if I create the layout `tech-support`, I'd add the following frontmatter to the top of a page in `pages/support/router.html.md`:
+
+```md
+---
+title: How to fix a router
+layout: tech-support
+---
+
+# How to fix a router
+
+1. Unplug the router.
+2. Plug in the router.
+```
+
+Sitepress will look for the layout in the `layouts` folder from the `layout` key in the file's frontmatter.
+
+Additionally, you may use the `render_layout` function in a page, or layout, to nest the layouts. For example, you could:
+
+```haml
+---
+title: How to fix a scanner
+---
+= render_layout "tech-support" do
+  %h1 How to fix a scanner
+
+  %ol
+    %li Unplug the scanner.
+    %li Plug in the scanner.
+```
+
+The `render_layout` can be used to nest a layout within a layout, which is a very powerful way to compose content pages.
+
+## File locations
+
+Like Rails, Sitepress organizes files in certain directories:
+
+* `pages` - This is where you'll edit the content. All `erb`, `haml`, and `md` files will be rendered and all other files will be served up. Support for other templating languages should work if you add them to the Gemfile and they already work with Rails.
+
+* `layouts` - Layouts for all pages may be found in this directory. Layouts are great for headers, footer, and other content that you'd otherwise be repeating across the files in `pages`.
+
+* `helpers` - Complex view code that you don't want to live in `page` or `layouts` can be extracted into helpers and re-used throughout the website. These are just like Rails helpers.
+
+* `assets` - If you want Sprockets to fingerprint and manage images, stylesheets, or scripts then put them in the `assets` directory.
+
+* `config` - All configuration files and initializers belong in this directory. The `config/site.rb` file has settings that can be changed for the Sitepress site. Changes made to this file require the `sitepress server` to be restarted.
+
+## Compiling & publishing the website
+
+Once you're satisfied with your website and you're ready to compile it into static HTML files, run `sitepress compile` and the website will be built to `./build`.
+
+## It's just Rails
+
+Anything you can do in Rails, you can do in Sitepress. If you find yourself needing more Rails for Sitepress, you could try adding it to the `Gemfile` and integrating it into your website. You can also embed and integrate Sitepress into a full-blown Rails app and serve up the content without statically compiling it.
+
+## More info
+
+Check out https://sitepress.cc for the latest and most up-to-date Sitepress documentation.

data/templates/default/Rakefile

@@ -1,7 +1,5 @@
 ## Example deployment script to an Amazon Web Servie S3 bucket.
-
-# Change the s3_url to whatever bucket you'd like to deploy to.
-s3_url = "s3://<insert-your-s3-bucket-here>/"
+s3_bucket_name = "<replace-with-your-bucket-name>"
 
 desc "Remove all files from the build directory"
 task :clean do
@@ -16,12 +14,12 @@ end
 namespace :publish do
   desc "Upload ./build/assets to S3 with cache-control headers optimized for assets"
   task :assets do
-    sh "aws s3 sync ./build/assets #{s3_url} --cache-control max-age=31536000"
+    sh "aws s3 sync ./build/assets s3://#{s3_bucket_name}/assets --cache-control max-age=31536000"
   end
 
   desc "Upload ./build to S3"
   task :pages do
-    sh "aws s3 sync ./build #{s3_url} --exclude 'assets/**' --cache-control max-age=60"
+    sh "aws s3 sync ./build s3://#{s3_bucket_name} --exclude 'assets/**' --cache-control max-age=60"
   end
 end
 

data/templates/default/pages/index.html.erb

@@ -3,13 +3,16 @@ title: Welcome to Sitepress
 ---
 
 <h3>Website files</h3>
-<p>All your website files are in <code><%= site.root_path.expand_path %></code>. If you've built stuff on Rails, you'll feel right at home because Sitepress was built on top of Rails.</p>
+<p>All the website files are in <code><%= site.root_path.expand_path %></code>. If you've built stuff on <a href="https://rubyonrails.org">Rails</a>, you'll feel right at home because Sitepress is actually running on Rails.</p>
 
 <h3>Assets</h3>
-<p>There's an asset pipeline at <code><%= site.assets_path.expand_path %></code> where you can put all of your images, stylesheets, and JavaScripts, which will be compiled and fingerprinted for your deployment.</p>
+<p>There's an asset pipeline at <code><%= site.assets_path.expand_path %></code> where you can put all of your images, stylesheets, and scripts, which will be compiled and fingerprinted for your deployment via Sprockets.</p>
 
 <h3>Compile</h3>
 <p>When you're ready to build the website, run <code>sitepress compile</code> and the website files and assets will all be built and compiled into the <code><%= site.root_path.join("build").expand_path %></code> path.</p>
 
+<h3>Deploy</h3>
+<p>An example Rakefile is included at <code><%= site.root_path.join("Rakefile").expand_path %></code> that deploys the build to an AWS S3 bucket. You can customize it to fit your needs or use a completely different deployment pipeline. Whatever floats your boat.</p>
+
 <h3>Documentation</h3>
 <p>Check out the <a href="https://sitepress.cc">Sitepress website</a> for help on getting started and documentation. Since Sitepress is also built on top of Rails, most of the <a href="https://guides.rubyonrails.org/action_view_helpers.html">Rails view helpers</a> work too.</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-cli
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta6
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sitepress-server
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: 2.0.0.beta6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: 2.0.0.beta6
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,8 @@ files:
 - lib/sitepress/repl.rb
 - sitepress-cli.gemspec
 - templates/default/.gitignore
-- templates/default/Gemfile
+- templates/default/Gemfile.tt
+- templates/default/README.md
 - templates/default/Rakefile
 - templates/default/assets/config/manifest.js
 - templates/default/assets/images/logo-brown.svg
@@ -76,6 +77,7 @@ files:
 - templates/default/config/site.rb
 - templates/default/helpers/page_helper.rb
 - templates/default/layouts/layout.html.erb
+- templates/default/pages/favicon.ico
 - templates/default/pages/index.html.erb
 homepage: https://github.com/sitepress/sitepress
 licenses: []