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

placeholder for github pages #55

Merged
merged 12 commits into from
Feb 18, 2020
Merged

Conversation

jmarcil
Copy link
Collaborator

@jmarcil jmarcil commented Feb 18, 2020

Following what's recently discussed on #44, this would be the target output by using PHPCS mechanism to generate sniff documentation.

I'm not 100% sure yet that I can generate the exact code for jekyll on GitHub Pages from PHPCS, but if it can all work together that'd be great.

Since it's just about the /docs directory needed by GitHub Pages, this PR has literally 0 impact on the tool itself.

@jmarcil jmarcil merged commit ec37657 into FloeDesignTechnologies:master Feb 18, 2020
@jrfnl
Copy link
Contributor

jrfnl commented Feb 18, 2020

I'm not 100% sure yet that I can generate the exact code for jekyll on GitHub Pages from PHPCS, but if it can all work together that'd be great.

FYI: that is one of the tools I intend to add to PHPCSDevTools, in case you're interested ;-)

The tool I envision would take the sniff description from the class docblock + provide information on public properties which can be set from the ruleset, and would generate the output as markdown so it can be used in a README, GH Wiki page and/or GH Pages site with Jekyll enabled.

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

Successfully merging this pull request may close these issues.

2 participants