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

feat: adding documentation with vitepress #80

Merged
merged 9 commits into from
Jan 13, 2022

Conversation

JessicaSachs
Copy link
Contributor

@JessicaSachs JessicaSachs commented Jan 11, 2022

Hello! This pull request adds infrastructure for a Vitepress website. The documentation is largely copy/pasted from @JeffBeltran 's "Un-official faker.js" docs here.

Should address #22 and then lay the foundation for building #46 (via the /playground/ page in docs/playground/index.md).

There is a netlify.toml file to deploy on Netlify and we have a free account sponsored by Netlify that will be setup tomorrow morning. Here's a preview of the site on my personal Netlify account https://61dd4313b4122d0007e9a5c4--boring-colden-7dfbbb.netlify.app/

I will say that there is a LOT of documentation that needs to be updated.

@Shinigami92 Shinigami92 added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Jan 11, 2022
Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

Could you run prettier over the docs?

README.md Outdated Show resolved Hide resolved
docs/.vitepress/theme/components/Badge.vue Outdated Show resolved Hide resolved
docs/.vitepress/theme/components/Playground.vue Outdated Show resolved Hide resolved
docs/api/address.md Show resolved Hide resolved
docs/api/address.md Outdated Show resolved Hide resolved
docs/guide/recent-faqs.md Outdated Show resolved Hide resolved
tsconfig.json Outdated Show resolved Hide resolved
@prisis
Copy link
Member

prisis commented Jan 11, 2022

Can you update the year from 2020 to 2022 :D

package-lock.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Copy link
Member

@damienwebdev damienwebdev left a comment

Choose a reason for hiding this comment

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

lgtm

@damienwebdev damienwebdev merged commit 71e9025 into faker-js:main Jan 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants