The Asciidoc skeleton simple-document a helper for setting up a base file and folder structure for simple-document AsciiDoc pages based on Jekyll and J1 Template. You need both to use this skeleton creating AsciiDoc documents from it.
Simple documents are used quite often for documents of a website. If the number of chapters is about or less than three and the document is small in size, simple documents should fit. This document type is based on a single Asciidoc document and does not use any (local) Asciidoc include files or attributes.
| Moving documents based on a J1 Skeleton All J1 Asciidoc Skeletons are fully relocateable and can be placed in any subfolder of your Jekyll site. |
Synopsis
Jekyll is a robot, an engine to generate a site from a site scaffold. The Jekyll Ruby Gem provides an executable named jekyll to be used at the commandline.
Several commands and related options are available to control how the engine jekyll generates a site.
jekyll <command> [options]Find all commands available for the executable jekyll with the following sections below.
Commands
To change Jekyll’s default behavior generating sites, have a look through the configuration options. All general options can be found with the section General commands. All specific commands and options to control build and serve processes for a site, see the sections for the Build command and the Serve command.
General commands
The executable jekyll provides some general commands to create e.g. a new site scaffold from the scratch (based on the default gem-based theme Minima) or some support commands like doctor to check the configuration of a site or clean to reset an existing, already generated site.
Have a look through the commands and options available this section.
| Command | Options and Flags | Description |
|---|---|---|
| To be clarified | |
| To be clarified | |
| Creates a new Jekyll site with default gem-based theme. Using optional | |
|
| Using optional |
| Outputs any deprecation or configuration issues | |
| Creates a new Jekyll theme scaffold | |
| Removes the generated site and metadata file | |
| Shows help, optionally for a given subcommand, e.g. |
Build command
Performs a one off build your site. For default, site pages gets written to the folder ./_site
jekyll build | b [options] Typically you’ll use jekyll serve while developing locally and jekyll build when you need to generate the site for production. |
| Options | Description |
|---|---|
| Use custom configuration file. |
| The current folder will be generated into DESTINATION |
| Custom source directory |
| Publishes posts with a future date |
| Limits the number of posts to parse and publish |
| Watch for changes and rebuild |
| Serve the website from the given base URL |
| Force watch to use polling |
| Use LSI for improved related posts |
| Render posts in the _drafts folder |
| Render posts that were marked as unpublished |
| Silence output |
| Print verbose output |
| Enable incremental rebuild |
| Fail if errors are present in front matter |
| Show detailed options an flags |
| Source directory. Defaults to current directory |
| Destination directory. Defaults to |
| Safe mode. Defaults to |
| Plugins directory. Defaults to |
| Layouts directory. Defaults to |
| Generate a Liquid rendering profile |
| Show the full backtrace when an error occurs |
| Print the name and version |
Serve command
Create your site any time a source file changes and serves it locally using builtin web server WEBRick.
For default, site pages gets writen to ./_site
jekyll serve | s [options] Typically you’ll use jekyll serve while developing locally and jekyll build when you need to generate the site for production. |
| Options | Description |
|---|---|
| Use custom configuration file. |
| The current folder will be generated into DESTINATION |
| Custom source directory |
| Publishes posts with a future date |
| Limits the number of posts to parse and publish |
| Watch for changes and rebuild |
| Serve the website from the given base URL |
| Force watch to use polling |
| Use LSI for improved related posts |
| Render posts in the _drafts folder |
| Render posts that were marked as unpublished |
| Silence output |
| Print verbose output |
| Enable incremental rebuild |
| Fail if errors are present in front matter |
| X.509 (SSL) certificate |
| X.509 (SSL) Private Key |
| Host to bind to |
| Launch your site in a browser |
| Run the server in the background |
| Port to listen on |
| Show a directory listing instead of loading your index file |
| Skips the initial site build which occurs before the server is started |
| Use LiveReload to automatically refresh browsers |
| Files for LiveReload to ignore. Remember to quote the values so your shell won’t expand them |
| Minimum reload delay |
| Maximum reload delay |
| Port for LiveReload to listen on |
| Show detailed options an flags |
| Source directory. Defaults to current directory |
| Destination directory. Defaults to |
| Safe mode. Defaults to |
| Plugins directory. Defaults to |
| Layouts directory. Defaults to |
| Generate a Liquid rendering profile |
| Show the full backtrace when an error occurs |
| Print the name and version |
Examples
Find some typical use case running Jekyll from commandline below.
Build a site from custom configuration
Typically you’ll use jekyll serve while developing locally and jekyll build when you need to generate the site for production.
jekyll b -c ./site_configs/_config.ymlBuild a site in mode incremental
Typically you’ll use jekyll serve while developing locally and jekyll build when you need to generate the site for production.
jekyll b --incrementalRun a site in mode incremental
Typically you’ll use jekyll serve while developing locally and jekyll build when you need to generate the site for production.
jekyll s --incremental