Skip to content
This repository has been archived by the owner on Apr 21, 2022. It is now read-only.

Add flag for setting output location of multi command docs #65

Merged
merged 1 commit into from
Oct 2, 2018

Conversation

AriTheElk
Copy link
Contributor

Ran into this issue when trying to use a markdown doc renderer like ignite. Since oclif forces multi docs to get saved to the root of the docs/ dir, I figured it might be nice if that could be overridden.

Even if you're not using a markdown renderer, it's useful to be able to change the folder structure, especially if your project has handwritten docs mixed in the docs/ dir.

In this PR, I made it changeable via the --dir flag. Not sure if that's a great name for it, so lmk if you'd like me to change it. Since the flag only applies to multi docs, it might make more sense to use a flag that has the word multi in it.

@salesforce-cla
Copy link

Thanks for the contribution! Before we can merge this, we need @garetmckinley to sign the Salesforce.com Contributor License Agreement.

Copy link
Contributor

@jdx jdx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're on a code freeze right now but I'll release this after next week

@jdx jdx merged commit 4874a22 into oclif:master Oct 2, 2018
oclif-bot added a commit that referenced this pull request Oct 2, 2018
# [1.19.0](v1.18.1...v1.19.0) (2018-10-02)

### Features

* add dir flag to readme ([#65](#65)) ([4874a22](4874a22))
@oclif-bot
Copy link
Contributor

🎉 This PR is included in version 1.19.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

None yet

3 participants