Material-ui: Publish documentation as docset

Created on 16 Sep 2020  路  3Comments  路  Source: mui-org/material-ui

Standalone documentation browsing apps like Dash, Zeal, and Velocity use a documentation packaging format called docset

The excellent Material UI docs would be even nicer if they were published in the docset format, available for local+offline search and perusal.

  • [x] I have searched the issues of this repository and believe that this is not a duplicate.

Summary 馃挕

Existing docs should be published and made available on the Kapeli/Dash-User-Contributions repository.

docs

Most helpful comment

@oliviertassinari I pushed a minimal docset-generating branch here; https://github.com/duncanbeevers/material-ui-docs

It leverages the existing build+export functionality, and relies on a 3rd-party tool dashing to build the docset.
Here's a zip of the generated docset; material-ui.docset.zip

Steps to test

  1. Clone repo + install dependencies
  2. Install dashing
  3. Generate docset $ yarn docs:docset
  4. Install docset by double-clicking in Finder, or adding manually in Dash

2020-09-16 at 11 35 AM
2020-09-16 at 11 36 AM

All 3 comments

@duncanbeevers would you be interested in working on the problem?

For the others interested, please upvote https://github.com/Kapeli/Dash-User-Contributions/issues/2384. Hopefully somebody from the community will fill this gap :).

@oliviertassinari I pushed a minimal docset-generating branch here; https://github.com/duncanbeevers/material-ui-docs

It leverages the existing build+export functionality, and relies on a 3rd-party tool dashing to build the docset.
Here's a zip of the generated docset; material-ui.docset.zip

Steps to test

  1. Clone repo + install dependencies
  2. Install dashing
  3. Generate docset $ yarn docs:docset
  4. Install docset by double-clicking in Finder, or adding manually in Dash

2020-09-16 at 11 35 AM
2020-09-16 at 11 36 AM

I'll see if I can find some more time to work on this. Obvious next steps might be:

  • Replace dashing Go binary usage with a node package like docset-generator.
  • Make single-language-selection explicit, instead of being driven implicitly from PULL_REQUEST=true environment variable.
  • Create a new rendering target where site-layout stuff like side and header bars are omitted.
Was this page helpful?
0 / 5 - 0 ratings

Related issues

activatedgeek picture activatedgeek  路  3Comments

anthony-dandrea picture anthony-dandrea  路  3Comments

ryanflorence picture ryanflorence  路  3Comments

pola88 picture pola88  路  3Comments

finaiized picture finaiized  路  3Comments