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.

Sign up for GitHub

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

Jump to bottom

Adds skipSidebar option for docusaurus2 #124

Merged
merged 1 commit into from Jun 2, 2020
Merged

Adds skipSidebar option for docusaurus2 #124

merged 1 commit into from Jun 2, 2020

Conversation

edchapel
Copy link
Contributor

@edchapel edchapel commented May 22, 2020 •
edited

@edchapel
Adds skipSidebar option for docusaurus2
dfda3fd 
* Extends typedoc2md#108 to the docusaurus2 theme also.
* Skips finding docusaurus root when skip is enabled.
* Updates documentation to indicate it is usable for both docusaurus themes.
@edchapel edchapel mentioned this pull request May 22, 2020
Closed
edchapel added a commit to edchapel/http4ts that referenced this pull request May 22, 2020
@edchapel
WIP: API docs created using Typedoc
aa7abd1 
* Uses docusaurus2 theme
* Linked in sidebar as a single page, currently titled "Globals"
* Individual members are *not* in the sidebar
* Adds `typedoc` npm script
  * Cleans the dir first
  * Runs typedoc using options configured in tsconfig.json
    * Relies on the `typedoc-plugin-markdown` plugin for docusaurus2 support
  * Removes the sidebar file that is incorrectly produced
    * The `skipSidebar` arg is not yet supported in `docusaurus2` (see typedoc2md/typedoc-plugin-markdown#124)
@edchapel edchapel mentioned this pull request May 22, 2020
Draft
3 tasks
tbjgolden
tbjgolden approved these changes May 24, 2020
View reviewed changes
Copy link

@tbjgolden tbjgolden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure it's my place to approve it but this is more or less how I would have done it

@tgreyuk tgreyuk merged commit b35a4d9 into typedoc2md:master Jun 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tbjgolden tbjgolden tbjgolden approved these changes

@tgreyuk tgreyuk tgreyuk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@edchapel @tbjgolden @tgreyuk