https://github.com/riboseinc/jekyll-duplicate
Jekyll plugin to render documents in additional ways
https://github.com/riboseinc/jekyll-duplicate
Last synced: about 2 months ago
JSON representation
Jekyll plugin to render documents in additional ways
- Host: GitHub
- URL: https://github.com/riboseinc/jekyll-duplicate
- Owner: riboseinc
- License: mit
- Created: 2020-06-22T14:47:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-27T15:55:56.000Z (almost 5 years ago)
- Last Synced: 2025-04-05T23:32:28.428Z (about 2 months ago)
- Language: Ruby
- Size: 5.86 KB
- Stars: 0
- Watchers: 9
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- License: LICENSE.txt
Awesome Lists containing this project
README
# Jekyll plugin to render documents in additional ways
This plugin allows to automatically generate an extra page
for each document in specified collection(s).
Additionally generated pages
can be assigned a different layout and/or extra frontmatter variables,
and will be placed under specified path.
## Use cases
* You want to keep documentation for your desktop app
available via app’s main site (as usual), while reusing the same pages
in context of app’s built-in web-based help, similar to e.g. what Xcode does.
In this scenario you’d likely want to have your in-app documentation
provide the same content, but in a slightly different layout
(for example, excluding some page elements).
* You want to output machine-readable JSON for each document.
## Configuration
Specify the following in your `_config.yml`:
```yaml
duplicate_documents:
in_collection:
under_url_prefix:
format:
# These two are optional
with_layout:
with_frontmatter:
:
...
```
## Notes and limitations
* Does not work with AsciiDoc or other pre-processed formats.
[Issue](../../../../riboseinc/jekyll-duplicate/issues/1).
* In case of JSON, you must still use a layout to build your structure.
Specify `layout: nil` in your layout.
Use `jsonify` filter to escape values or convert Ruby structures to JSON.
* Currently, no nesting in extra frontmatter is allowed.
[Issue](../../../../riboseinc/jekyll-duplicate/issues/2).
* If any frontmatter specified clashes with page’s original frontmatter,
frontmatter from jekyll-duplicate configuration will prevail.
## Caution
Pages with duplicate content are discouraged by search engines.
You may, for example, want to make sure that extra pages, if they’re HTML,
are not linked to from the “main site” and do not get indexed.
## Contributing
PRs are welcome.
## Release process
* Update version number in `.gemspec` and commit your change.
* Run `./develop/release` to publish new gem version, tag the repo and push to GitHub.