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

add and integrate typedoc with docusaurus #1382

Closed
awentzel opened this Issue Feb 14, 2019 · 0 comments

Comments

Projects
None yet
2 participants
@awentzel
Copy link
Member

commented Feb 14, 2019

What feature are you requesting?
Creation and integration of TypeDoc generated API's with Docusaurus site.

What would be the benefit of adding this feature?
Documentation site to seamlessly integrate Marketing + Development + API documentation all under one domain.

What solution would be ideal for you?
When looking at any package page, for example, there would be an additional section displayed as a link named API /api which would contain the complete API documentation subsite generated by TypeDoc and be accessible as a link from the existing readme.md file. As shown:
screen shot 2019-02-14 at 11 57 07 am

Is there any additional context for your request?
A couple challenges exist:

  1. Every time docusuaurus publishes all contents are regenerated in website/build/fast-dna so anything placed in there from earlier scripted routines will be deleted.
  2. What is required from GH Pages to ensure that all .html files can be linked and executed as a single site even though it's really a bunch of subsites. There may be a solution here
  3. Getting the proper status result after spawning TypeDoc commands.

Attach screenshots or images add detail to your request:

Requirements

  • Default TypeDoc theme is acceptable
  • TypeDoc should compile to html
  • TypeDoc can copy files into the ./website/build folder which is gitignored
  • Website/build/fast-dna/docs/en/packages/
    • Fast-animation
    • Fast-application-utilities
    • Fast-components-*
      • Api/*
      • Index.html
      • etc
  • Package readme.md should reference a link to the API documentation index.html page
  • API site should render on gh-pages as seamless integration with Docusaurus generated pages
  • Site can look and feel independently of the Guide and Marketing pages.
  • Several packages are ignored in script and this is ok since they require refactor later to bring into
  • The package.json script section should include a new script "docs:publish" which will execute the following:
    • Copy-package-readme.js
    • Generate-typedocs.js
    • Integrate typedocs with docusaurus

Deployment
At which point ./website/build/fast-dna would contain the entire set of documentation (Marketing and Technical) and can be bundled and deployed to a single Azure App Service for the domain https://fastdna.net.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.