Skip to content

New repo/structure for AsciiDocsy docs deployment once theme is gem? #65

@briandominick

Description

@briandominick

For the 3.0 release, in which AsciiDocsy will be packaged as a Ruby gem (#31), we will want the AsciiDocsy docs themselves (the documentation that covers the AsciIDocsy theme), to not be based in the root dir of any Jeklyll application using this theme.

For any use of the theme gem, including AsciiDocsy docs's own use, we want the application root to be definitional and for everything in it to override. So we either need to clean up the directory structure and have a distinct Jekyll application inside the gem file structure, or we need to separate the docs out and have a distinct repo use the the way any other application would. This has the advantage of demonstrating a relatively organic use of the theme. Unfortunately, it means another repo, and I think a self-documenting gem is really what's called for, so we'll probably just have a docs/ dir that can be used for Jekyll executions against the content inside it, with a _config.yml file there that does not interfere with the config for an app that might call the gem.

Metadata

Metadata

Assignees

No one assigned

    Labels

    CI/CDJekyllInvolves working heavily with or extending Jekyll SSGRubyInvolves some Ruby troubleshooting/coding

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions