Skip to content

Commit f4f9279

Browse files
briandominickbriandominick
authored
LiquiDoc CMF V3 Bootstrap & Boilerplate
This PR releases version 3 of the LiquiDoc Content Management Framework. * The Readme has been wholly upgraded, mostly for clarity but also in preparation for serving as source for external repos, notably the [WIP "LiquiDoc CMF Guides" project](https://github.com/DocOps/liquidoc-cmf). * The comment-suppressed `jekyll` block of the boilerplate `Gemfile` has been uncommented and thus will install with `bundle install`/`bundle update` commands. * Adds templates for initiating topics. The new commands generate a file with default/templated content as well as print to console a chunk of YAML for including in a `manifest.yml` file. * Templatizes files that were in `_configs/` directory in V2, now built during init only. * Lots of clarifying work in `data/meta.yml`. * Clarifies bootstrapping instructions, which have been tested in multiple environments. * Adds an HTML edition of the default document and tidied up the build. * Huge thanks and ++ to @diggerlilly for thorough review under pressure. We're getting close to this thing being user friendly in the ways it deserves!
1 parent a6e409f commit f4f9279

32 files changed

Lines changed: 805 additions & 132 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
build
22
Gemfile.lock
3+
.DS_Store

‎Gemfile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ group :asciidoctor_plugins do
1212
gem 'asciidoctor-diagram'
1313
end
1414

15-
# gem 'jekyll'
16-
# group :jekyll_plugins do
17-
# gem 'jekyll-asciidoc'
18-
# end
15+
gem 'jekyll'
16+
group :jekyll_plugins do
17+
gem 'jekyll-asciidoc'
18+
end

‎README.adoc‎

Lines changed: 281 additions & 44 deletions
Large diffs are not rendered by default.

‎_configs/build-docs.yml‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎_init/init.yml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎_init/templates/init.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
- action: parse
2+
data:
3+
file: data/meta.yml
4+
builds:
5+
- output: README.adoc
6+
template: _init/templates/init_readme.asciidoc
7+
- output: content/index.adoc
8+
template: _init/templates/init_index.asciidoc
9+
- output: {{project_config_dir}}/{{project_config_file}}
10+
template: _init/templates/init_build-config.yaml
11+
- output: {{project_config_dir}}/jekyll-global.yml
12+
template: _init/templates/init_jekyll-global.yaml
13+
- output: {{project_config_dir}}/asciidoctor.yml
14+
template: _init/templates/init_asciidoctor.yaml

_configs/asciidoctor.yml renamed to _init/templates/init_asciidoctor.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# This file contains global Asciidoctor attributes
22
imagesdir: assets/images
3+
snippetsdir: ../snippets
34
safe: 0
45
icons: font

‎_init/templates/init_build-config.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Move critical files to the temporary build directory
2+
- action: migrate
3+
source: content/
4+
target: _build/
5+
options:
6+
inclusive: false # Duplicate the files without the content/ dir
7+
- action: migrate
8+
source: theme/
9+
target: _build/
10+
# Prebuild includable files
11+
- action: parse
12+
data: data/terms.yml
13+
builds:
14+
- output: _build/snippets/_built_terms.adoc
15+
template: _templates/liquid/terms.asciidoc
16+
- action: parse
17+
data: data/meta.yml
18+
builds:
19+
- output: _build/snippets/_built_company-info.adoc
20+
template: _templates/liquid/company-info.asciidoc
21+
# Render your publication with Asciidoctor
22+
- action: render
23+
source: _build/index.adoc
24+
data:
25+
- _configs/asciidoctor.yml
26+
- data/meta.yml
27+
builds:
28+
- output: _build/docs/docs.html
29+
doctype: book
30+
- output: _build/docs/docs.pdf
31+
doctype: book
32+
# Migrations in preparation for deploy
33+
- action: migrate
34+
source: _build/assets/
35+
target: _build/docs/

‎_init/templates/init_index.asciidoc‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1-
= {{product_common_name}}
1+
= {{ product_suite_name }}
22

33
== Maker Info
44

5-
include::includes/_built_company-info.adoc[]
5+
include::snippets/_built_company-info.adoc[]
6+
7+
:leveloffset: +1
8+
9+
include::pages/about.adoc[]
10+
11+
include::topics/intro.adoc[]
12+
13+
:leveloffset: -1
14+
15+
= Appendices
16+
17+
include::pages/jargon-guide.adoc[leveloffset=+1]

‎_init/templates/init_jekyll-global.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# This is the Jekyll configuration file
2+
title: {{product_suite_name}} Portals
3+
description: The documentation for {{project_subjects_list}}
4+
output: web
5+
source: {{project_build_dir}}
6+
host: 127.0.0.1
7+
port: {{local_serve_port}}
8+
destination: site
9+
10+
data_dir: data
11+
plugins_dir: _plugins
12+
layouts_dir:
13+
includes_dir:
14+
images_dir: assets/images
15+
css_dir: theme/css
16+
theme_common_dir: theme
17+
js_dir: theme/js
18+
19+
asciidoc: {}
20+
asciidoctor:
21+
safe: 0
22+
base_dir: :docdir
23+
# Do NOT place attributes here when building with LiquiDoc
24+
# They will be loaded from other external sources
25+
26+
27+
# File management
28+
encoding: "utf-8"

0 commit comments

Comments
 (0)