progrium / viewdocs

Read the Docs meets Gist.io for simple Markdown project documentation

Home Page:http://viewdocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Question: Best way to run the server locally

fgrehm opened this issue · comments

I'm planning to use viewdocs for some of my projects and it would be really nice to have a way to run the server locally to preview the changes I'm making without the need to push to github and wait for the cache to expire.

What would be the best way to handle that? I'm up for doing the required changes if we agree on how that should work :)

Oh boy. Well, I'm not sure what would be simpler, having a completely
rewritten version for local mode included, or to include a web server to
serve local files to look like github URLs...

I'd have to think about it some more. :\

On Mon, Nov 25, 2013 at 5:17 PM, Fabio Rehm notifications@github.comwrote:

I'm planning to use viewdocs for some of my projects and it would be
really nice to have a way to run the server locally to preview the changes
I'm making without the need to push to github and wait for the cache to
expire.

What would be the best way to handle that? I'm up for doing the required
changes if we agree on how that should work :)


Reply to this email directly or view it on GitHubhttps://github.com//issues/10
.

Jeff Lindsay
http://progrium.com

No worries, I'll try to come up with something next week :)

I did some work on this today and came up with https://github.com/fgrehm/viewdocs-preview which is basically the same code from this repo trimmed out make it work with a local docs directory.

It's just a start but now I can have a local environment to test things out without flooding people's timeline with lots of test commits!

@progrium I don't know what are your thoughts on having a separate project for that but I'd be happy to send a PR with that code once I'm able to iron out some issues =)

I like it. Great way to solve it

On Tuesday, December 3, 2013, Fabio Rehm wrote:

I did some work on this today and came up with
https://github.com/fgrehm/viewdocs-preview which is basically the same
code from this repo trimmed out make it work with a local _docs_directory.

It's just a start but now I can have a local environment to test things
out without flooding people's timeline with lots of test commits!

@progrium https://github.com/progrium I don't know what are your
thoughts on having a separate project for that but I'd be happy to send a
PR with that code once I'm able to iron out some issues =)


Reply to this email directly or view it on GitHubhttps://github.com//issues/10#issuecomment-29774269
.

Jeff Lindsay
http://progrium.com

Awesome, I'll look into ways of making it less "copy & paste"-ty by extracting things into separate components that I can import from the other repo and will report back with PRs as I go :)

It's so simple you probably don't need to do that. In fact, you can
probably simplify your project even more by removing the caching.

On Wed, Dec 4, 2013 at 5:20 AM, Fabio Rehm notifications@github.com wrote:

Awesome, I'll look into ways of making it less "copy & paste"-ty by
extracting things into separate components that I can import from the other
repo and will report back with PRs as I go :)


Reply to this email directly or view it on GitHubhttps://github.com//issues/10#issuecomment-29803698
.

Jeff Lindsay
http://progrium.com

Yeah, that makes sense :)

So I made some major progress today and I'm quite happy with the current status of it. Would you be interested on adding a link to it on this project's docs/index.md?

If not, I think we can just close the issue 😃

Sure, I'll take a PR for it. :)

On Wed, Dec 4, 2013 at 6:53 PM, Fabio Rehm notifications@github.com wrote:

So I made some major progress today and I'm quite happy with the current
status of it. Would you be interested on adding a link to it on this
project's docs/index.md?

If not, I think we can just close the issue [image: 😃]


Reply to this email directly or view it on GitHubhttps://github.com//issues/10#issuecomment-29867581
.

Jeff Lindsay
http://progrium.com