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

Doc: Generate gh-pages base on MD files with Docpress #506

Closed
wants to merge 1 commit into from
Closed

Doc: Generate gh-pages base on MD files with Docpress #506

wants to merge 1 commit into from

Conversation

zckrs
Copy link

@zckrs zckrs commented Feb 3, 2016

Hi,

With Docpress we can have a github pages who based content on docs folder.

Temporarily you can view result here http://zckrs.github.io/ava/ pushed by Travis build.

If you are interested and ready to merge I will configure for the source repo and squash commit.

Note:

  • media moved into docs folder

@sindresorhus
Copy link
Member

Looks good, but not sure of its use-case when it's just a rendering of the readme?

* 10ad1a2 Move media into docs/media
* 076aa09 Use "docpress"
* 3f96378 Auto build/deploy by TravisCI
@zckrs
Copy link
Author

zckrs commented Feb 8, 2016

Commits squashed


Documentations accessible via a web application with a navigation can help some users.
And AVA can be more popular with it.

@zckrs
Copy link
Author

zckrs commented Feb 8, 2016

For deployement by TravisCI you should add env variable GITHUB_TOKEN in https://travis-ci.org/sindresorhus/ava/settings

@sindresorhus
Copy link
Member

Documentations accessible via a web application with a navigation can help some users.

We already have a Table of Contents menu in the readme.

And AVA can be more popular with it.

Not really a concern right now.

None of the arguments are very convincing.

@vdemedes @jamestalmage What do you think about adding this?

@jamestalmage
Copy link
Contributor

I think it looks nice. I like the Nav. I like that we get it almost for free just by generating a Readme.

@zckrs - You made a number of edits (moving things in to doc folder, etc). That I don't understand why they were necessary. I'm assuming that's required by Docpress? That would be my one big objection. I don't want to spend time trying to make my Readme acceptable to some third party post-processor.

My gut is that it's got potential, but maybe a bit premature to start focusing on this / letting it take up the maintainers time.

@zckrs
Copy link
Author

zckrs commented Feb 8, 2016

@jamestalmage yes I moved media folder into docs because Docpress is based on docs to resolve path.

@vadimdemedes
Copy link
Contributor

I agree with @sindresorhus point, it's a pretty wrapper for the exactly same content. I don't see how it would help AVA become more popular.

Moreover, we have a website planned when we reach near-1.0 release (#162).

@zckrs We have to pass on this PR for now, but thank you for your work and effort to contribute to AVA! Little tip, to avoid these kinds of situations, where work does not get merged, I recommend opening an issue first and see what other people think about your idea.

@zckrs
Copy link
Author

zckrs commented Feb 9, 2016

No problem
You are right I should open issue but I like coding ^^

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.

4 participants