New SDK Reference Website #289
Merged
Conversation
This file contains hidden or 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
haoliu-amp
suggested changes
Sep 3, 2020
Contributor
haoliu-amp
left a comment
haoliu-amp
left a comment
There was a problem hiding this comment.
All the generated markdown file shouldn't be checked into master branch.
They should be generated when you trigger a new release and putting them to gh-pages branch.
haoliu-amp
approved these changes
Sep 3, 2020
kelvin-lu
approved these changes
Sep 3, 2020
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "serve": "docusaurus build --out-dir build/Amplitude-JavaScript && yarn run docusaurus serve" |
Contributor
There was a problem hiding this comment.
how would you feel if docusarus did not run on port :3000 as default? :)
jooohhn
added a commit
to jooohhn/Amplitude-JavaScript
that referenced
this pull request
Sep 21, 2020
* init docusaurus * remove blog * replace image assets * update footer * update navbar * update docusaurus config * edit landing page * change css theme * add amplitude-js docs * add jsdoc-to-markdown * add generate-jsdoc.js and prettier to format md output * Replace default docs with generated API docs * remove footer content * make sidebar uncollapsible * add syntax highlight to examples * change docusaurus target browsers * change docs to include constructor * make website docs only * change docs/ to website/ * fix baseUrl config * Fix baseUrl problem with yarn serve * update readme * delete autogenerated docs * Add autogenerated docs to gitignore
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.
Check it out at https://amplitude.github.io/Amplitude-JavaScript/
Summary
website/folder containing content for developing and deploying the reference website using docusaurusnpx @docusaurus/init@next init docs classictemplate and replaces it with amplitude related contentwebsite/generate-jsdoc.jsthat scanssrc/and outputs autogenerated markdown docs inwebsite/docs/jsdoc2mdpackage as an API to interact with jsdoc commentswebsite/README.mdfor development and deployment instructions