You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<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)
13
13
</div>
14
14
15
15
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.
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.
56
63
57
64
```shell script
65
+
$ npm run build
58
66
$ npm start
59
67
```
60
-
68
+
61
69

62
-
70
+
63
71
6. Commit and push the changes in your working directory to the remote repository.
64
72
65
73
```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"
68
76
$ git push origin master
69
77
```
70
78
@@ -97,10 +105,10 @@ Modify an ejs template to change the contents of the existing page. For example,
97
105
</main>
98
106
```
99
107
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.
101
109
102
110
```shell script
103
-
$ npm run publish page
111
+
$ npm run build
104
112
$ npm start
105
113
```
106
114
@@ -115,14 +123,10 @@ If you're ready to deploy, run `npm run deploy` script. You can change not only
115
123
*`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.
116
124
*`article` - HTML files converted from `_articles` directory.
117
125
*`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.
123
128
* `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.
0 commit comments