pomp/pompy.dev
1
0
Fork 0
Code Issues 8 Pull requests Activity Actions

better structuring for the "how it works section"

Browse source
This commit is contained in:
Kim, Jimin 2021-07-31 08:51:24 +09:00
parent 4bc30cb6e3
commit 5686c1947e
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -44,13 +44,13 @@ Please read the [`CONTRIBUTING.md`](./CONTRIBUTING.md) file.
# How it works # How it works
The command `yarn start` does two things under the hood. > Check the [`generator.ts`](./source/generate.ts) source code for more detailed information.
First it executes the [generate.ts](./source/generate.ts) script to convert [markdown files](./source/markdown) to json files so it can be imported by react during runtime. The script also creates `map.js` file which is used to search posts without having to go through all of them each time. To just generate these files without starting the app, run `yarn generate` command in the [`source` directory](./source). The command `yarn start` does two things under the hood:
Then it serves the app in http://localhost:3000 as normal just like any other react apps. 1. it executes the [generate.ts](./source/generate.ts) script that converts [markdown files](./source/markdown) to json files so it can be imported by react during runtime. To perform the conversion without serving the app, run `yarn generate` command in the [`source` directory](./source).
The `yarn build` command will create files that can be served in the actual website. 2. it serves the app in http://localhost:3000 as normal just like any other react apps.
# Special thanks # Special thanks