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

updated developomp.com project description

Browse source
This commit is contained in:
Kim, Jimin 2022-01-15 10:21:44 +09:00
parent 3d2f5a3dfa
commit 545cf9c857
1 changed files with 19 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

33
source/markdown/portfolio/developomp.com.md
View file

@ -16,38 +16,43 @@ badges:
## Intro ## Intro
developomp.com is my website built for blogging and hosting data such as images, portfolio, resume, etc. developomp.com is my website built for blogging, data hosting, portfolio, resume, etc.
It is Hosted on google firebase, and domain registered with amazon AWS Route 53. It is hosted on [google firebase](https://firebase.google.com), and domain registered with [amazon AWS](https://aws.amazon.com) Route 53.
It is built with Node.js, React.js and typescript. It is built with Node.js, React.js and typescript.
## How it works ## How it works
The build process of the site can be categorized into three stages. The build process of the site can be categorized into three stages.
### content generation ### 1. content generation
In this stage, markdown files are rendered to HTML, json files containing metadata are generated, and svg images are built. In this stage, markdown files are rendered to HTML, json files containing metadata are generated, and svg images are constructed.
Check the `auto generated files` section of the [.gitignore](https://github.com/developomp/developomp-site/blob/master/.gitignore#L4) file to learn where these files are saved. These files are all saved in the `source/src/data` directory with exceptions for some image files which are saved in the `source/public/img` directory.
Check the [deployment github action](https://github.com/developomp/developomp-site/blob/master/.github/workflows/firebase-hosting-deploy.yml) for specific commands.
#### markdown #### A. HTML generation
In this stage, [Markdown files](https://github.com/developomp/developomp-site/tree/master/source/markdown) are rendered to HTML using the [markdown-it](https://github.com/markdown-it/markdown-it) library.
[Markdown files](https://github.com/developomp/developomp-site/tree/master/source/markdown) are rendered to HTML using the [markdown-it](https://github.com/markdown-it/markdown-it) library.
Check the [parsemarkdown.ts](https://github.com/developomp/developomp-site/blob/master/source/generate/parseMarkdown.ts) file to see the conversion logic and plugins used. Check the [parsemarkdown.ts](https://github.com/developomp/developomp-site/blob/master/source/generate/parseMarkdown.ts) file to see the conversion logic and plugins used.
#### metadata #### B. metadata
To allow content searching and listing, json files containing metadata such as available tags, posts categorized by tags, posts sorted by date, etc. are created. To allow content searching and listing, json files containing metadata such as title, length, and tags are generated.
[elasticlunr.js](https://github.com/weixsong/elasticlunr.js) library is also used to allow searching by content. The [elasticlunr.js](https://github.com/weixsong/elasticlunr.js) library is also used for searching.
#### images #### C. images
svg images are generated so they can be used in other sites like in my [github profile](https://github.com/developomp#skills). svg images are generated so they can be used in other sites like in my [github profile](https://github.com/developomp#skills).
The [EJS](https://ejs.co) templates and style used to generate the image can be found in `source/generate/portfolio`.
### site-building ### 2. site-building
Just a classic boring react build process. Uses [react-scripts](https://www.npmjs.com/package/react-scripts). Just a classic boring react build process. Uses [react-scripts](https://www.npmjs.com/package/react-scripts).
### deployment ### 3. deployment
The site is deployed to firebase. The site is deployed to firebase.
## Limitations
Since the site does not support server side rendering (SSR), the pages might be too slow to use for some weaker devices.