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

Document the new typed version of Mars Theme #75

Open
luisherranz opened this issue Jul 9, 2021 · 5 comments
Open

Document the new typed version of Mars Theme #75

luisherranz opened this issue Jul 9, 2021 · 5 comments

Comments

@luisherranz
Copy link
Member

Hey guys, we are about to release a typed version of mars-theme that @DAreRodz and I made during our last pair programming sessions:

Any thoughts about how to reflect that in the docs? Should we use the same mars-theme docs, stating that there is a TypeScript version of it should have their own docs?

@mburridge
Copy link
Member

If this version is functionally the same as the standard JS version then I don't think it needs it's own page. Perhaps just an info box is needed on this page saying that if npx frontity create is run with the --typescript flag then the TS version of mars-theme will be installed.

It should probably also be mentioned in the --typescript row in this table.

@juanmaguitar what's your opinion on this?

@JeffreyHelder
Copy link

Hi Frontity team! Very impressed with the continues progress being made!

For the company I work for, I am currently exploring Frontity to use as a foundation in our dev-environments for future clients who already use/are familiar with WordPress. Our company favors Typescript and so I was very happy to see all the work being put into making Typescript support not only possible but easy.

My humble opinion as a newer web-developer is alike other frameworks it would be nice to see ts having it's own sections in the docs pages where things are slightly different (simple togglable js/ts switch at the top for the snippets, explanations, etc). I don't think there would be much of a difference but I say this because when I first started with typescript outside of work, if I didn't have these options I would greatly shy away from that particular framework instead of taking the time to learn it, which would be a shame for Frontity!

Looking forward to see what's to come!

@luisherranz
Copy link
Member Author

simple togglable js/ts switch at the top for the snippets, explanations, etc

That's a good idea.

@juanma is that easy to do in Gitbook?

@michalczaplinski
Copy link
Member

I have removed a broken link to the docs for the mars-theme-typescript because those docs don't exist yet 😛

Once the docs have been created please add the link to them in the README.md of the mars-theme-typescript.

@luisherranz

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants