Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow dev option of Composer require command via meta-data (front-matter) #79

Open
froschdesign opened this issue Feb 27, 2022 · 0 comments
Assignees

Comments

@froschdesign
Copy link
Member

froschdesign commented Feb 27, 2022

The Composer require command is displayed on the start page of each documentation as installation command.
If a package is required for developing then the dev option can be added to the command on the start page.

This can be configured via a configuration entry in the mkdocs.yml file but it would be more intuitive to insert this directly into the related file.

Current Usage

mkdocs.yml:

extra:
    project: Components
    installation:
        composer_dev: true

https://github.com/laminas/laminas-coding-standard/blob/bcf6e07fe4690240be7beb6d884d0b0fafa6a251/mkdocs.yml#L9-L10

Preferred Usage

index.md:

---
installation:
    composer_dev: true
---

# Example

https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data

Example

https://docs.laminas.dev/laminas-coding-standard/#installation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant