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

TSConfig Reference Overview #103

Merged
merged 13 commits into from
Nov 4, 2019
Merged

TSConfig Reference Overview #103

merged 13 commits into from
Nov 4, 2019

Conversation

orta
Copy link
Contributor

@orta orta commented Nov 1, 2019

End Goal

Screen Shot 2019-11-01 at 11 37 47 AM

  • editor on the left with Monaco +JSON schema autocomplete, cmd clicking on a key scrolls the right hand side
  • right hand side is a long scrollable (linkable) reference for each TSConfig option

This PR

Creates the long scrollable reference as a markdown file, by collating a series of smaller markdown files into one markdown file per language. Yep, this is internationalized already.

The markdown ref from the first draft: English - Pirate ( The copy for the "basic types" is different from English (but the URL is the same) and allowJs too. )

Each config option has it's own markdown file, and in this layout we can really fill out those docs and people can trivially make PRs to edit and improve these docs as one-offs.

@orta orta mentioned this pull request Nov 1, 2019
11 tasks
@orta
Copy link
Contributor Author

orta commented Nov 1, 2019

I think it's feasible to ship this page as just another markdown file in the existing site and slowly build it out to be the full designed version with monaco post re-design

@orta orta merged commit 137e40a into v2 Nov 4, 2019
@jakebailey jakebailey deleted the tsconfig_doc branch May 17, 2024 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant