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

Output Docs as Markdown #711

Open
drobertson123 opened this issue Jul 15, 2017 · 2 comments
Open

Output Docs as Markdown #711

drobertson123 opened this issue Jul 15, 2017 · 2 comments

Comments

@drobertson123
Copy link

The st-docs functionality of Storyteller is great. I especially like being able to pull code examples into the docs.

One issue that I am running into is that several projects I am working on are not public. Pushing the docs to GitHub pages, that are by default public, doesn't work for those projects. It would be extremely helpful to output the merged documents into a common document location as a Markdown file.

This would give us the ability to compile all the help down to one markdown file location that would work inside our private GitHub project.

@jeremydmiller
Copy link
Member

@drobertson123 How would you see that working though? Are you wanting the stdocs content exported to markdown, or to pull in external content into stdocs files as markdown?

@drobertson123
Copy link
Author

I was hoping for the ability to export st-docs as markdown inside my own project.

st-docs has some great features for pulling together disparate MD files and I especially like the ability to pull code examples right into the docs.

My issue is that most of my projects are not public and we are not looking for HTML content. I think the HTML content you can produce is great, but it would be far more valuable to me if I could get a consolidated documentation.md file produced inside my project as a reference for the devs. Using st-docs to create and update that would be wonderful.

I would see this as an alternate output, possibly making both HTML and MD docs.

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

No branches or pull requests

2 participants