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

publish docs package as standalone theme #852

Closed
4 tasks done
giladgray opened this issue Mar 16, 2017 · 3 comments
Closed
4 tasks done

publish docs package as standalone theme #852

giladgray opened this issue Mar 16, 2017 · 3 comments

Comments

@giladgray
Copy link
Contributor

giladgray commented Mar 16, 2017

After #796, we'll be using documentalist to build the docs data and the docs package to render it. Next big step is to package up the docs package so it can be used OOTB as a theme for (a particular configuration of) documentalist.

This includes:

  • move custom code out of docs package (to site-docs)
  • use tsc build like other published packages
  • make docs package publishable
  • what to do with layout code currently in blueprint gulp task? moved into DM
@brsanthu
Copy link

While we talking about the docs package, is it possible to extract the nav menu as a component? it is really nice :)

@giladgray
Copy link
Contributor Author

@brsanthu unfortunately no, as the NavMenu is quite specific to the documentation context: its interface only makes sense when you've got data in the exact format that our tooling produces. (it's nothing more than a recursive renderer for a nested tree structure.)

on the other hand, the forthcoming published docs package will include a host of documentation components that can be reused, assuming you've got data in the correct format.

@giladgray giladgray added this to the 1.14.0 milestone Apr 4, 2017
@giladgray
Copy link
Contributor Author

shipped in v1.14.0!

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

No branches or pull requests

2 participants