bendtherules/UiQuestions
1
0
Fork 0
mirror of https://github.com/bendtherules/UiQuestions.git synced 2026-08-18 13:52:50 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

Readme - Add basic info

Browse Source 
And shorten existing Docusaurus commands in readme to a contributing section.
This commit is contained in:
bendtherules
2020-10-14 23:03:59 +05:30
parent de1d494474
commit 7b5aec389e
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -11
View File
@@ -1,14 +1,26 @@
# Website [![Netlify Status](https://api.netlify.com/api/v1/badges/e3374d45-5349-4ffc-8d52-4c67ee846463/deploy-status)](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 ```console
yarn install yarn install
``` ```
## Local Development ### Local Development
```console ```console
yarn start 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. 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 ```console
yarn build 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. This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment ### Deployment
```console Auto-deployed via Netlify
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.