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

Add Docusaurus website #875

Merged
merged 26 commits into from
Nov 11, 2021
Merged

Add Docusaurus website #875

merged 26 commits into from
Nov 11, 2021

Conversation

edew
Copy link
Contributor

@edew edew commented Oct 25, 2021

Type of PR: enhancement

PR checklist:

Overview of change:

This PR adds a documentation website built with Docusaurus.

See https://edew.github.io/lightweight-charts/ for a demo.

There's a lot that we can improve. Interactive examples, more tutorials, etc. but this is a good start.

Is there anything you'd like reviewers to focus on?

Once we are happy with this and it is merged the noIndex option can be disabled - I have left it on for now so (hopefully) the version of the site hosted on my personal GitHub Pages branch isn't indexed.

@timocov timocov mentioned this pull request Nov 3, 2021
Copy link
Contributor

@timocov timocov left a comment

Choose a reason for hiding this comment

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

Additionally, is it possible to generate favicon from svg on the fly?

package.json Outdated Show resolved Hide resolved
website/.gitignore Outdated Show resolved Hide resolved
.eslintignore Outdated Show resolved Hide resolved
website/static/img/logo.svg Outdated Show resolved Hide resolved
website/package.json Show resolved Hide resolved
website/package.json Outdated Show resolved Hide resolved
website/package.json Outdated Show resolved Hide resolved
website/package.json Outdated Show resolved Hide resolved
website/docusaurus.config.js Show resolved Hide resolved
website/tsconfig.json Show resolved Hide resolved
@edew edew requested a review from timocov November 9, 2021 13:29
@edew
Copy link
Contributor Author

edew commented Nov 10, 2021

Additionally, is it possible to generate favicon from svg on the fly?

I'm sure it's possible. We would have to write something custom. Do you think it's something we should do?

.circleci/config.yml Outdated Show resolved Hide resolved
@timocov timocov merged commit b7e5a4a into tradingview:master Nov 11, 2021
@timocov timocov added this to the 3.8 (optional) milestone Nov 11, 2021
@edew edew deleted the add-docusaurus-site branch November 22, 2021 10:20
@timocov timocov added the documentation Improvements or additions to the documentation label Nov 26, 2021
@timocov timocov modified the milestone: 3.8 Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs website and improve the docs
2 participants