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.

Sign up for GitHub

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

docs(website): update installation and links in README #1435

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −7
Open

docs(website): update installation and links in README #1435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions packages/website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Check out our [website][2] for a complete explanation and documentation.

# Installation

1. `yarn install` in the root of this repository (two level above this directory).
1. In the this directory, do `yarn install`.
1. In this directory, do `yarn start`.
1. A browser window will open up, pointing to the docs.
1. Open `http://localhost:3000/`.
1. See [Docusaurus document][10] for detail.

# Deployment

Expand All @@ -20,9 +21,5 @@ Netlify handles the deployment of this website. If you are part of the DocSearch
[2]: https://docsearch.algolia.com/
[3]: https://api.netlify.com/api/v1/badges/30eacc09-d4b2-4a53-879b-04d40aaea454/deploy-status
[4]: https://app.netlify.com/sites/docsearch/deploys
[6]: https://github.com/algolia/docsearch
[7]: https://github.com/algolia/docsearch-configs
[8]: https://github.com/algolia/docsearch-scraper
[9]: https://github.com/algolia/docsearch-website
[10]: https://v2.docusaurus.io/
[10]: https://docusaurus.io/docs
[11]: https://app.netlify.com/sites/docsearch/overview