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

multiple pages? #1

Open
lookfirst opened this issue Jan 25, 2012 · 12 comments
Open

multiple pages? #1

lookfirst opened this issue Jan 25, 2012 · 12 comments
Labels

Comments

@lookfirst
Copy link

This looks great, but I organize my documentation across multiple pages. I don't want to stick everything in a single file. Anyway that you can support that in the future?

@jeromegn
Copy link
Owner

Yes most likely. I'm already developing new features and enhancements.

@neerajsingh0101
Copy link

Multi page support will be awesome. Thanks for great work .

@alganet
Copy link

alganet commented Feb 3, 2012

It would be awesome if multi-page support included GitHub wiki pages as well.

@taylorotwell
Copy link

+1 for this. Any ETA? If it helps I would be willing to throw in a donation for this.

@jeromegn
Copy link
Owner

jeromegn commented Feb 6, 2012

Here's my thought on this: You could "mount" pages.

Definitely would be in the documentup.json config, maybe like so:

{
  "mount": [
    "/api": "/docs/api.md",
    "/man-pages": "/docs/man.md"
  ]
}

Thoughts?

The only reason this isn't "automatic" (eg: visiting /something would look for something.md or /something/readme.md) is because it would be harder to know when to recompile. I'd have to poll Github for changes every x times. With the config I just know exactly when to recompile the pages. (if you have a post-receive hook installed, which you should!)

@fd
Copy link

fd commented Feb 6, 2012

+1

@neerajsingh0101
Copy link

+1 looks awesome

@taylorotwell
Copy link

The "mount" option looks good! I take it the "value" side (/docs/api.md) would correspond to the path within the Github repo?

Might also need a way to mount the sidebar to a specific file or something too?

@jeromegn
Copy link
Owner

jeromegn commented Feb 6, 2012

Yes, need to think about this.

Also have to keep almost the same UX for repos that don't have multiple pages of docs.

@chadyj
Copy link

chadyj commented May 8, 2013

+1
Would love to see this for our docs at https://github.com/Sendicate/sendicate-docs

@jeromegn
Copy link
Owner

If anybody is still watching this: technically you can now point to subpages and it will render them. Not sure how well though, still a work in progress.

@brylie
Copy link

brylie commented Sep 9, 2015

Is there an example of adding sub-page links to the navigation menu?

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

No branches or pull requests

8 participants