You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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:
The text was updated successfully, but these errors were encountered: