HPCE/gitea-pages
0
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Activity

committing new version of jekyll doc theme -- 5.0, with some refinements to come with the documentation

Browse Source
This commit is contained in:
tomjohnson1492
2016-03-19 00:13:09 -07:00
parent e267cce513
commit 7a869d7cd4
206 changed files with 16935 additions and 37629 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
mydoc/mydoc_build_arguments.md
View File

@@ -2,8 +2,10 @@
title: Build arguments
tags: [publishing]
keywords: building, serving, serve, build
last_updated: November 30, 2015
summary: "When you have a single sourcing project, you use more advanced arguments when you're building or serving your Jekyll sites. These arguments specify a particular configuration file and may build on other configuration files."
last_updated: March 20, 2016
summary: "You use various build arguments with your Jekyll project. You can also create shell scripts to act as shortcuts for long build commands. You can store the commands in iTerm as profiles as well."
sidebar: mydoc_sidebar
permalink: /mydoc_build_arguments/
---
## How to build Jekyll sites
@@ -23,16 +25,20 @@ jekyll serve
By default, the _config.yml in the root directory will be used, Jekyll will scan the current directory for files, and the folder `_site` will be used as the output. You can customize these build commands like this:
```
jekyll serve --config configs/config_writers.yml --destination /users/tjohnson/projects/documentation-theme-jekyll-builds/writer
jekyll serve --config configs/myspecialconfig.yml --destination ../doc_outputs
```
Here the `configs/config_writers.yml` file is used instead of `_config.yml`. The destination directory is `../mydoc_writers`.
Here the `configs/myspecialconfig.yml` file is used instead of `_config.yml`. The destination directory is `../doc_outputs`, which would be one level up from your current directory.
## Shortcuts for the build arguments
If you don't want to enter the long Jekyll argument every time, with all your configuration details, you can create a shell script and then just run the script. This theme shows an example with the mydoc_multibuild_web.sh file in the root directory.
If you have a long build argument and don't want to enter it every time in Jekyll, noting all your configuration details, you can create a shell script and then just run the script. Simply put the build argument into a text file and save it with the .sh extension (for Mac) or .bat extension (for Windows). Then run it like this:
My preference is to add the scripts to profiles in iTerm. See {{site.data.mydoc.mydoc_urls.mydoc_iterm_profiles.link}} for more details.
```
. myscript.sh
```
My preference is to add the scripts to profiles in iTerm. See {{site.data.urls.mydoc_iterm_profiles.link}} for more details.
## Stop a server
@@ -54,9 +60,9 @@ To kill all Jekyll instances, use this:
kill -9 $(ps aux | grep '[j]ekyll' | awk '{print $2}')
```
I created a profile in iTerm that stores this command. Here's what the iTerm settings look like:
I recommend creating a profile in iTerm that stores this command. Here's what the iTerm settings look like:
![iTerm profile settings to kill all Jekyll](images/killalljekyll.png)
![iTerm profile settings to kill all Jekyll]({{ "/images/killalljekyll.png" | prepend: site.baseurl }})