Skip to content

Add github_markdown library to libraries index #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DannyBen wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add github_markdown library to libraries index #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/render-mandoc/docs/download.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 3.9
.\"
.TH "download" "1" "March 2026" "Version 0.1.0" "Sample application"
.TH "download" "1" "May 2026" "Version 0.1.0" "Sample application"
.SH NAME
\f[B]download\f[R] \- Sample application
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion examples/render-mandoc/docs/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% download(1) Version 0.1.0 | Sample application
% Lana Lang
% March 2026
% May 2026

NAME
==================================================
Expand Down
15 changes: 15 additions & 0 deletions lib/bashly/libraries/libraries.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,21 @@ render_markdown:

m`$ bashly render templates/markdown docs`

render_markdown_github:
help: Copy the github markdown templates to your project, allowing you to customize the markdown documentation output.
skip_src_check: true
files:
- source: "render/markdown_github/README.md"
target: "templates/markdown_github/README.md"
- source: "render/markdown_github/markdown.gtx"
target: "templates/markdown_github/markdown.gtx"
- source: "render/markdown_github/render.rb"
target: "templates/markdown_github/render.rb"
post_install_message: |
Generate your markdown documentation by running:

m`$ bashly render templates/markdown_github docs`

render_mandoc:
help: Copy the mandoc templates to your project, allowing you to customize the man documentation output.
skip_src_check: true
Expand Down
4 changes: 4 additions & 0 deletions spec/approvals/cli/add/list
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ render_markdown
Copy the markdown templates to your project, allowing you to customize the
markdown documentation output.

render_markdown_github
Copy the github markdown templates to your project, allowing you to customize
the markdown documentation output.

render_mandoc
Copy the mandoc templates to your project, allowing you to customize the man
documentation output.
Expand Down
2 changes: 1 addition & 1 deletion spec/bashly/library_source_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
expect(subject.libraries.keys).to match_array %i[
colors completions completions_script completions_yaml config
help hooks ini lib settings stacktrace strings validations yaml
render_markdown render_mandoc
render_markdown render_markdown_github render_mandoc
]
end

Expand Down
Loading