Documentation Upgrade - Now with a Playground! #28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ntation as a standalone demo page. Update gitignore to include dist and dist.browser as ts-markdown artifacts to ignore. Added rollup, rollup typescript plugin, tslib, and uglify-js dev dependencies for bundling and minifying the web project. Added rollup config. Added new custom-docs dir and rollup config file to npmignore. Added scripts for copying the custom github pages into the docs and for building the web version of ts-markdown. Removed unused imports where found.
Added color scheme toggle to the playground. Added copied css files to the custom-docs directory to allow for local doc testing. Adjusted web build to copy specific files over.
|
Closes #25 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added custom-docs directory to house any non-TypeDoc content, starting with the playground. Temporarily add
Updated "documentation refresh" scripting to copy in additional content from the custom-docs directory (specific files only) after generating the TypeDocs.
Added web build of ts-markdown in its own dist.browser folder. This web build currently exists to provide a static web-friendly version of ts-markdown for running in the playground, but it can be used by anyone on a website.