ostree/docs/_config.yml

title: ostreedev/ostree
description: ostree documentation
baseurl: "/ostree"
url: "https://ostreedev.github.io"
# Comment above and use below for local development
# url: "http://localhost:4000"
permalink: /:title/
markdown: kramdown
kramdown:
  typographic_symbols:
    ndash: "--"
    mdash: "---"

# Exclude the README and the bundler files that would normally be
# ignored by default.
exclude:
  - README.md
  - Gemfile
  - Gemfile.lock
  - prep-docs.sh
  - vendor/

# These are copies of the apidoc/html and man/html directories. Run
# prep-docs.sh before jekyll to put it in place.
include: [reference, man]

remote_theme: coreos/just-the-docs
plugins:
  - jekyll-remote-theme

color_scheme: coreos

# Aux links for the upper right navigation
aux_links:
  "OSTree on GitHub":
    - "https://github.com/ostreedev/ostree"

footer_content: "Copyright &copy; <a href=\"https://www.redhat.com\">Red Hat, Inc.</a> and <a href=\"https://github.com/ostreedev\">others</a>."

# Footer last edited timestamp
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p"

# Footer "Edit this page on GitHub" link text
gh_edit_link: true
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/ostreedev/ostree"
gh_edit_branch: "main"
gh_edit_source: docs
gh_edit_view_mode: "tree"

compress_html:
  clippings: all
  comments: all
  endings: all
  startings: []
  blanklines: false
  profile: false
docs: Add Jekyll and theme config 2020-09-28 17:55:03 +03:00			`title: ostreedev/ostree`
			`description: ostree documentation`
			`baseurl: "/ostree"`
docs: Fix URL in Jekyll _config.yml 2020-10-05 22:10:31 +03:00			`url: "https://ostreedev.github.io"`
docs: Add Jekyll and theme config 2020-09-28 17:55:03 +03:00			`# Comment above and use below for local development`
			`# url: "http://localhost:4000"`
			`permalink: /:title/`
			`markdown: kramdown`
docs: Do not convert -- & --- to en/em-dash '--' is frequently used for command line options and was thus incorrectly rendered as a special en-dash symbol. 2021-10-11 13:29:21 +03:00			`kramdown:`
			`typographic_symbols:`
			`ndash: "--"`
			`mdash: "---"`
docs: Add Jekyll and theme config 2020-09-28 17:55:03 +03:00
docs: Provide bundler setup for building site locally This mimics the GitHub Pages environment so that you can build and serve the site locally for testing. It's will also be required later for using Jekyll Actions[1] instead of the automated GitHub Pages flow. 1. https://github.com/marketplace/actions/jekyll-actions 2021-05-20 23:48:16 +03:00			`# Exclude the README and the bundler files that would normally be`
			`# ignored by default.`
			`exclude:`
			`- README.md`
			`- Gemfile`
			`- Gemfile.lock`
docs: Copy in API docs and add link Make a copy of `apidoc/html` to `docs/reference` and then tell Jekyll to include it verbatim. This will include the gtk-doc API docs on the static site. A link is added to the main index. A script is added to do the copy (a symlink won't do) and is setup to run before Jekyll in the GitHub workflow. Ideally this would be a local Jekyll plugin to make the process automatic, but the github-pages gem doesn't allow that. 2021-05-21 01:03:56 +03:00			`- prep-docs.sh`
docs: Provide bundler setup for building site locally This mimics the GitHub Pages environment so that you can build and serve the site locally for testing. It's will also be required later for using Jekyll Actions[1] instead of the automated GitHub Pages flow. 1. https://github.com/marketplace/actions/jekyll-actions 2021-05-20 23:48:16 +03:00			`- vendor/`

docs: Publish man pages Make a copy of `man/html` to `docs/man` and then configure Jekyll to include it verbatim like the API docs. A link is added to the main index and the necessary commands are added to the github docs workflow. 2022-04-09 00:30:07 +03:00			`# These are copies of the apidoc/html and man/html directories. Run`
			`# prep-docs.sh before jekyll to put it in place.`
			`include: [reference, man]`
docs: Copy in API docs and add link Make a copy of `apidoc/html` to `docs/reference` and then tell Jekyll to include it verbatim. This will include the gtk-doc API docs on the static site. A link is added to the main index. A script is added to do the copy (a symlink won't do) and is setup to run before Jekyll in the GitHub workflow. Ideally this would be a local Jekyll plugin to make the process automatic, but the github-pages gem doesn't allow that. 2021-05-21 01:03:56 +03:00
docs: Add Jekyll and theme config 2020-09-28 17:55:03 +03:00			`remote_theme: coreos/just-the-docs`
			`plugins:`
			`- jekyll-remote-theme`

			`color_scheme: coreos`

			`# Aux links for the upper right navigation`
			`aux_links:`
			`"OSTree on GitHub":`
			`- "https://github.com/ostreedev/ostree"`

			`footer_content: "Copyright © <a href=\"https://www.redhat.com\">Red Hat, Inc.</a> and <a href=\"https://github.com/ostreedev\">others</a>."`

			`# Footer last edited timestamp`
			`last_edit_timestamp: true`
			`last_edit_time_format: "%b %e %Y at %I:%M %p"`

			`# Footer "Edit this page on GitHub" link text`
			`gh_edit_link: true`
			`gh_edit_link_text: "Edit this page on GitHub"`
			`gh_edit_repository: "https://github.com/ostreedev/ostree"`
*: rename master branch to main 2021-05-07 17:38:16 +03:00			`gh_edit_branch: "main"`
docs: fix "Edit this page on GitHub" links 2021-04-10 05:58:54 +03:00			`gh_edit_source: docs`
docs: Add Jekyll and theme config 2020-09-28 17:55:03 +03:00			`gh_edit_view_mode: "tree"`

			`compress_html:`
			`clippings: all`
			`comments: all`
			`endings: all`
			`startings: []`
			`blanklines: false`
			`profile: false`