Skip to content

Add general non-pattern markdown docs to pattern library views #274

@LucidDan

Description

@LucidDan

Describe the solution you'd like

I'd like to be able to add - both within sections, and at the root level - general markdown files as full page documentation that aren't related to a pattern.

For example, I'd like to be able to have a "Introduction" at the top of the root level of the index, where I can put some information about the library and how to use it, etc.

Somewhat related, I'd like to be able to add a documentation page that isn't related to a pattern, and have it show up as a full page markdown - for example, "Notes regarding Page patterns" or other design notes or guidance for groups of patterns in a particular section or sub-section.

I think the way for this to work would just be to have markdown files in the template directory where the patterns go, but without an actual pattern (html) file.
For top-level markdown, this would maybe need to have a configuration entry in PATTERNS to configure a directory to look in for additional markdown pages.

Describe alternatives you've considered

The alternative is either using something like storybook, but that's still a big leap in complexity that I really don't want to make. This feature would significantly extend the usefulness of django-pattern-library for me, before needing to consider things like Storybook.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions