mirror of
https://github.com/bendtherules/UiQuestions.git
synced 2026-08-18 13:52:50 +00:00
Readme - Add basic info
And shorten existing Docusaurus commands in readme to a contributing section.
This commit is contained in:
@@ -1,14 +1,26 @@
|
||||
# Website
|
||||
[](https://app.netlify.com/sites/uiquestions/deploys)
|
||||
|
||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
||||
# [Ui Questions](http://uiquestions.com/)
|
||||
|
||||
## Installation
|
||||
> Need a quick review before UI/Frontend interview? Start at http://uiquestions.com/
|
||||
|
||||
Primary goal of the website is to have "I have 30 minutes before interview"-style coverage of frontend topics.
|
||||
It should be short, with links to other websites for further reading.
|
||||
|
||||
The first section will be on **DOM and events**, then I'll add some common UI tasks asked in interview, like how to build *infinite scroll*.
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. The instructions below is taken from their readme.
|
||||
|
||||
### Installation
|
||||
|
||||
```console
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Local Development
|
||||
### Local Development
|
||||
|
||||
```console
|
||||
yarn start
|
||||
@@ -16,7 +28,7 @@ yarn start
|
||||
|
||||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
## Build
|
||||
### Build
|
||||
|
||||
```console
|
||||
yarn build
|
||||
@@ -24,10 +36,6 @@ yarn build
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
## Deployment
|
||||
### Deployment
|
||||
|
||||
```console
|
||||
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
Auto-deployed via Netlify
|
||||
Reference in New Issue
Block a user