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

docs system #64

Open
themightychris opened this issue Nov 12, 2014 · 0 comments
Open

docs system #64

themightychris opened this issue Nov 12, 2014 · 0 comments
Assignees
Milestone

Comments

@themightychris
Copy link
Member

A simple handler for browsing markdown-based documentation stored within the VFS. A new root collection named docs will contain collections for books. Initial built-in books will include emergence and emergence-skeleton and new books can be added by/for packages, skeletons, and sites.

Each book may have a top-level file toc.md containing a nested list of links designing the toc, or if none is provided one will be generated on-demand (but not saved) containing all markdown files in lexical order.

site-root/docs.php will handle /docs/[book]/[*] routes, rendering markdown files and passing through everything else as a static asset (including .php files which would be samples/templates used in the docs).

A config array on the DocsRequestHandler class will allow for per-book access control settings. Books will be staff-only by default.

The docs system already in place on emr.ge and slate.is is very similar and will provide a good starting point, support for books will need to be added and the JSON manifest replaced with the toc.md+autotoc solution.

Future features:

  • Browse books+tocs from an alternate tab to the file browser in EmergenceEditor
  • Search docs from within EmergenceEditor
@themightychris themightychris self-assigned this Nov 12, 2014
@themightychris themightychris added this to the 0.5 milestone Nov 12, 2014
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

1 participant