Skip to content

Commit b83e3f1

Browse files
committed
add hints in render scripts
1 parent aa3afac commit b83e3f1

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

lib/bashly/libraries/render/mandoc/render.rb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
# render script - mandoc
2+
#
3+
# You may set the environment variable PREVIEW to the full command you wich
4+
# to preview while generating. For example:
5+
#
6+
# PREVIEW="cli download" bashly render :mandoc docs --watch
7+
#
8+
# Alternatively, view any of the man pages with man:
9+
#
10+
# man docs/cli.1
11+
#
212

313
# Load the GTX template
414
template = "#{source}/mandoc.gtx"

lib/bashly/libraries/render/markdown/render.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# render script - markdown
2+
#
3+
# In order to preview your markdown files, you can use the madness markdown
4+
# server <https://madness.dannyb.co/>:
5+
#
6+
# $ gem install madness
7+
# $ madness server docs
8+
#
29

310
# Load the GTX template
411
template = "#{source}/markdown.gtx"

0 commit comments

Comments
 (0)