Skip to content

Commit a78598e

Browse files
committed
docs: update README.md
1 parent bee84f3 commit a78598e

File tree

7 files changed

+33
-29
lines changed

7 files changed

+33
-29
lines changed

README.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55

66
Handmade Blog
77

8-
[![build](https://img.shields.io/github/workflow/status/ParkSB/handmade-blog/Node%20CI/master?style=flat-square)](https://github.com/ParkSB/handmade-blog/actions?query=workflow%3A%22Node+CI%22) ![node](https://img.shields.io/badge/node-%3E%3D%2010.0-brightgreen?style=flat-square) [![demo](https://img.shields.io/netlify/3f01acb3-1107-470a-914f-90d100b87d85?label=demo&style=flat-square)](https://handmade-blog.netlify.com/) [![license](https://img.shields.io/github/license/ParkSB/handmade-blog?style=flat-square)](LICENSE)
8+
[![build](https://img.shields.io/github/workflow/status/parksb/handmade-blog/Node%20CI/master?style=flat-square)](https://github.com/parksb/handmade-blog/actions?query=workflow%3A%22Node+CI%22) ![node](https://img.shields.io/badge/node-%3E%3D%2010.0-brightgreen?style=flat-square) [![demo](https://img.shields.io/netlify/3f01acb3-1107-470a-914f-90d100b87d85?label=demo&style=flat-square)](https://handmade-blog.netlify.com/) [![license](https://img.shields.io/github/license/parksb/handmade-blog?style=flat-square)](LICENSE)
99

1010
</h1>
11-
12-
<strong>Read this document in another language:</strong> [:kr:](README-KO.md) [:indonesia:](README-ID.md) [:brazil:](README-PT-BR.md) [:it:](README-IT.md) [:malaysia:](README-MS.md) [:greece:](README-EL.md)
11+
12+
<strong>Read this document in another language:</strong> [:kr:](_docs/README-KO.md) [:indonesia:](_docs/README-ID.md) [:brazil:](_docs/README-PT-BR.md) [:it:](_docs/README-IT.md) [:malaysia:](_docs/README-MS.md) [:greece:](_docs/README-EL.md)
1313
</div>
1414

1515
Handmade Blog is a lightweight static blog generator for people who want to start a blog quickly. It supports article type document for a blog post, work type document for portfolio, code highlights, [KaTeX](https://katex.org/) syntax, footnotes, and more.
1616

17-
## Demo: [Here](https://handmade-blog.netlify.com/)
17+
## Demo: [Here](https://handmade-blog.vercel.app/)
1818

1919
![Article page preview](https://user-images.githubusercontent.com/6410412/74097056-be43d100-4b4a-11ea-806b-7bd263d7f623.png)
2020

@@ -40,31 +40,39 @@ Handmade Blog is a lightweight static blog generator for people who want to star
4040
$ npm install
4141
```
4242

43-
4. Modify `config.json` file in `services` directory to set your blog title and subtitle.
44-
45-
```json
46-
{
47-
"blogTitle": "Betty Grof",
48-
"blogSubtitle": "Oh My Glob",
49-
"article": {
50-
"tableOfContents": true
51-
}
52-
}
43+
4. Customize a some texts such as title of the navigation(in `app/templates/navigations.ejs`), and run `npm run build`.
44+
45+
```html
46+
<nav>
47+
<a class="logo-link" href="/">
48+
<h1>CUSTOMIZED BLOG TITLE</h1>
49+
<span>customized blog subtitle</span>
50+
</a>
51+
<small>
52+
<a id="about" class="info-link" href="/about.html">👀About</a> /
53+
<a id="works" class="info-link" href="/works.html">🔥Works</a> /
54+
<a id="articles" class="info-link" href="/articles.html">📚Articles</a>
55+
</small>
56+
</nav>
57+
```
58+
``` shell script
59+
$ npm run build
5360
```
5461

55-
5. Start a local server at `http://localhost:1234/`. `npm start` script opens the local server based on `server` directory.
62+
5. Run `npm start` script to start a local server listening on `http://localhost:8080/`. The local server is based on `dist` directory.
5663

5764
```shell script
65+
$ npm run build
5866
$ npm start
5967
```
60-
68+
6169
![The website that is titled 'Betty Grof' at http://localhost:1234/](https://user-images.githubusercontent.com/6410412/93754683-155f6780-fc3d-11ea-99de-92c747c103f9.png)
62-
70+
6371
6. Commit and push the changes in your working directory to the remote repository.
6472

6573
```shell script
66-
$ git add ./services/config.json
67-
$ git commit -m "Set the blog title and subtitle"
74+
$ git add ./app/templates/navigations.ejs
75+
$ git commit -m "Customize the blog title and subtitle"
6876
$ git push origin master
6977
```
7078

@@ -97,10 +105,10 @@ Modify an ejs template to change the contents of the existing page. For example,
97105
</main>
98106
```
99107
100-
Then, run `npm run publish page` script to publish the modified landing page and preview changes on the local server using `npm start` script.
108+
Then, run `npm run build` script to publish the modified landing page and preview changes on the local server using `npm start` script.
101109
102110
```shell script
103-
$ npm run publish page
111+
$ npm run build
104112
$ npm start
105113
```
106114
@@ -115,14 +123,10 @@ If you're ready to deploy, run `npm run deploy` script. You can change not only
115123
* `public` - HTML files generated by `publish` script. `server` and `dist` directory is based on this directory. Do not change the files under this directory directly.
116124
* `article` - HTML files converted from `_articles` directory.
117125
* `work` - HTML files converted from `_works` directory.
118-
* `src` - Source code to be imported by HTML files.
119-
* `css` - CSS files generated by `build` script.
120-
* `scss`
121-
* `ts`
122-
* `static` - Any static files that aren't compiled by `build` script like `robots.txt`, `sitemap.xml`, or SEO files. `build` script copies all files under this directory to `dist` directory.
126+
* `styles` - CSS source code to be imported by HTML files.
127+
* `static` - Any static files that aren't compiled by `build` script like `robots.txt`, `sitemap.xml`, or SEO files. `build` script copies all files under this directory to `dist` directory.
123128
* `templates` - EJS template files. `publish` script converts templates under this directory to HTML files.
124-
* `dist` - Files compiled by `build` script. `deploy` script deploys a website to GitHub pages based on this directory. Do not change the files under this directory directly.
125-
* `server` - Files compiled by `build` script. `start` script opens local server based on this directory. Do not change the files under this directory directly.
129+
* `dist` - Files compiled by `build` script. `start` script opens local server based on this directory, and `deploy` script deploys a website to GitHub pages based on this directory. Do not change the files under this directory directly.
126130
* `services` - Source code implementing `publish` script.
127131
* `classes`
128132
* `models`
@@ -137,7 +141,7 @@ If you're ready to deploy, run `npm run deploy` script. You can change not only
137141
138142
### `npm start`
139143
140-
Starts local development server at http://localhost:1234/.
144+
Starts local development server listening on http://localhost:8080/.
141145
142146
### `npm run publish`
143147
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)