README.md in jekyll-theme-open-project-2.0.14 vs README.md in jekyll-theme-open-project-2.0.15

- old
+ new

@@ -23,14 +23,18 @@ * [Style customization](#style-customization) * [SVG guidelines](#svg-guidelines) * [Content guidelines](#content-guidelines) -* [Layouts](#theme-layouts) -* [Includes](#theme-includes) +* [Authoring content](#authoring-content) +* References: + * [Layouts](#theme-layouts) + * [Includes](#theme-includes) + + ## Starting a site with this theme ### Getting started with Ruby If you aren’t using Ruby often, the recommended way to install it is with RVM. @@ -114,10 +118,15 @@ url: https://example.com # Site’s URL with protocol, without optional www. prefix # and without trailing slash. # Used e.g. for marking external links in docs and blog posts. + github_repo_url: https://github.com/example-org/example.com + # URL to GitHub repo for the site. + # Using GitHub & specifying this setting is currently required + # for “suggest edits” buttons to show on documentation pages. + title: Example description: The example of examples # The above two are used by jekyll-seo-tag for things such as # `<title>` and `<meta>` tags, as well as elsewhere by the theme. @@ -647,9 +656,39 @@ - Project, software, spec description: about 12 words, no markup - Project description (featured): about 20-24 words, no markup - Blog post title: 3–7 words - Blog post excerpt: about 20–24 words, no markup + +## Authoring content + +Content is expected to be authored in AsciiDoc. +Some features, such as in-page navigation in software/project documentation +and code listing copy buttons, +require HTML structure to match the one generated from AsciiDoc by jekyll-asciidoc +and won’t work with content is authored in Markdown, for example. + +### Disabling copy button on code listings + +By default, each code listing widget, like below, will have a copy button +next to the `<pre>` element. + +``` +[source,sh] +---- +docker pull ribose/metanorma +---- +``` + +To disable that button for a particular listing, add `.nocopy` class to it: + +``` +[.nocopy] +[source,sh] +---- +docker pull ribose/metanorma +---- +``` ## Theme includes Commonly used overridable includes are (paths relative to your site root):