readme fix

This commit is contained in:
Artur Akmalov
2023-05-21 18:07:22 +05:00
parent 4d37fc3c18
commit bce85fd52d

View File

@@ -1,41 +1,34 @@
# Website
<h2 align="center">
Личный блог для записей
</h2>
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
<pre align="center">
Build with 🦖<a href="https://docusaurus.io/">Docusaurus</a>
</pre>
### Installation
<pre align="center">
<a href="https://test.akmalov.com">🖥 Online Preview</a>
</pre>
```
$ npm i
## Local Development
Git clone this project into local
```shell
git clone https://github.com/akmalovaa/akmalov.com.git
cd mxsm-website
```
### Local Development
then update
```shell
npm update --force
```
$ npm start
local development
```shell
npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true npm deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> npm 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.